mentions method

Future<DynamiteResponse<ChatMentionsResponseApplicationJson, void>> mentions({ required String token, required String search, ChatMentionsApiVersion? apiVersion, int? limit, ChatMentionsIncludeStatus? includeStatus, 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:

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

Status codes:

• 200: List of mention suggestions returned

See:

• $mentions_Request for the request send by this method.
• $mentions_Serializer for a converter to parse the Response from an executed request.

Implementation

Future<_i1.DynamiteResponse<ChatMentionsResponseApplicationJson, void>> mentions({
  required String token,
  required String search,
  ChatMentionsApiVersion? apiVersion,
  int? limit,
  ChatMentionsIncludeStatus? includeStatus,
  bool? oCSAPIRequest,
}) async {
  final _request = $mentions_Request(
    token: token,
    search: search,
    apiVersion: apiVersion,
    limit: limit,
    includeStatus: includeStatus,
    oCSAPIRequest: oCSAPIRequest,
  );
  final _streamedResponse = await _rootClient.httpClient.send(_request);
  final _response = await _i3.Response.fromStream(_streamedResponse);

  final _serializer = $mentions_Serializer();
  return _i1.ResponseConverter<ChatMentionsResponseApplicationJson, void>(_serializer).convert(_response);
}