mentions method
Future<DynamiteResponse<ChatMentionsResponseApplicationJson, void> >
mentions({
- required String search,
- required String token,
- int? limit,
- ChatMentionsIncludeStatus? includeStatus,
- ChatMentionsApiVersion? apiVersion,
- 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 to20
.includeStatus
Include the user statuses. Defaults to0
.apiVersion
Defaults to"v1"
.token
oCSAPIRequest
Required to be true for the API request to pass. Defaults totrue
.
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 search,
required String token,
int? limit,
ChatMentionsIncludeStatus? includeStatus,
ChatMentionsApiVersion? apiVersion,
bool? oCSAPIRequest,
}) async {
final _request = $mentions_Request(
search: search,
token: token,
limit: limit,
includeStatus: includeStatus,
apiVersion: apiVersion,
oCSAPIRequest: oCSAPIRequest,
);
final _response = await _rootClient.httpClient.send(_request);
final _serializer = $mentions_Serializer();
final _rawResponse =
await _i1.ResponseConverter<ChatMentionsResponseApplicationJson, void>(_serializer).convert(_response);
return _i1.DynamiteResponse.fromRawResponse(_rawResponse);
}