mentionsRaw method

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

Search for mentions.

This method and the response it returns is experimental. The API might change without a major version bump.

Returns a Future containing a DynamiteRawResponse with the raw HttpClientResponse and serialization helpers. 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:

  • mentions for an operation that returns a DynamiteResponse with a stable API.

Implementation

@_i4.experimental
_i1.DynamiteRawResponse<ChatMentionsResponseApplicationJson, void> mentionsRaw({
  required String search,
  required String token,
  int? limit,
  ChatMentionsIncludeStatus? includeStatus,
  ChatMentionsApiVersion? apiVersion,
  bool? oCSAPIRequest,
}) {
  final _parameters = <String, dynamic>{};
  final _headers = <String, String>{'Accept': 'application/json'};

// coverage:ignore-start
  final authentication = _rootClient.authentications?.firstWhereOrNull(
    (auth) => switch (auth) {
      _i1.DynamiteHttpBearerAuthentication() || _i1.DynamiteHttpBasicAuthentication() => true,
      _ => false,
    },
  );

  if (authentication != null) {
    _headers.addAll(
      authentication.headers,
    );
  }

// coverage:ignore-end
  final $search = _$jsonSerializers.serialize(search, specifiedType: const FullType(String));
  _parameters['search'] = $search;

  final $token = _$jsonSerializers.serialize(token, specifiedType: const FullType(String));
  _i2.checkPattern(
    $token as String?,
    RegExp(r'^[a-z0-9]{4,30}$'),
    'token',
  );
  _parameters['token'] = $token;

  var $limit = _$jsonSerializers.serialize(limit, specifiedType: const FullType(int));
  $limit ??= 20;
  _parameters['limit'] = $limit;

  var $includeStatus =
      _$jsonSerializers.serialize(includeStatus, specifiedType: const FullType(ChatMentionsIncludeStatus));
  $includeStatus ??= 0;
  _parameters['includeStatus'] = $includeStatus;

  var $apiVersion = _$jsonSerializers.serialize(apiVersion, specifiedType: const FullType(ChatMentionsApiVersion));
  $apiVersion ??= 'v1';
  _parameters['apiVersion'] = $apiVersion;

  var $oCSAPIRequest = _$jsonSerializers.serialize(oCSAPIRequest, specifiedType: const FullType(bool));
  $oCSAPIRequest ??= true;
  _headers['OCS-APIRequest'] = const _i2.HeaderEncoder().convert($oCSAPIRequest);

  final _path = _i3.UriTemplate(
    '/ocs/v2.php/apps/spreed/api/{apiVersion}/chat/{token}/mentions{?search*,limit*,includeStatus*}',
  ).expand(_parameters);
  return _i1.DynamiteRawResponse<ChatMentionsResponseApplicationJson, void>(
    response: _rootClient.executeRequest(
      'get',
      _path,
      headers: _headers,
      validStatuses: const {200},
    ),
    bodyType: const FullType(ChatMentionsResponseApplicationJson),
    headersType: null,
    serializers: _$jsonSerializers,
  );
}