mentions method

Future<DynamiteResponse<ChatMentionsResponseApplicationJson, void>> mentions({
  1. required String search,
  2. required String token,
  3. int? limit,
  4. ChatMentionsIncludeStatus? includeStatus,
  5. ChatMentionsApiVersion? apiVersion,
  6. bool? oCSAPIRequest,
})

Search for mentions.

Returns a Future containing a DynamiteResponse with the status code, deserialized body and headers. Throws a DynamiteApiException if the API call does not return an expected status code.

Parameters:

  • search Text to search for.
  • limit Maximum number of results. Defaults to 20.
  • includeStatus Include the user statuses. Defaults to 0.
  • apiVersion Defaults to v1.
  • token
  • oCSAPIRequest Required to be true for the API request to pass. Defaults to true.

Status codes:

  • 200: List of mention suggestions returned

See:

  • mentionsRaw for an experimental operation that returns a DynamiteRawResponse that can be serialized.

Implementation

Future<_i1.DynamiteResponse<ChatMentionsResponseApplicationJson, void>> mentions({
  required String search,
  required String token,
  int? limit,
  ChatMentionsIncludeStatus? includeStatus,
  ChatMentionsApiVersion? apiVersion,
  bool? oCSAPIRequest,
}) async {
  final rawResponse = mentionsRaw(
    search: search,
    token: token,
    limit: limit,
    includeStatus: includeStatus,
    apiVersion: apiVersion,
    oCSAPIRequest: oCSAPIRequest,
  );

  return rawResponse.future;
}