$mentions_Request method

  1. @experimental
Request $mentions_Request({
  1. required String token,
  2. required String search,
  3. ChatMentionsApiVersion? apiVersion,
  4. int? limit,
  5. ChatMentionsIncludeStatus? includeStatus,
  6. bool? oCSAPIRequest,
})

Search for mentions.

Returns a DynamiteRequest backing the mentions operation. 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 for a method executing this request and parsing the response.
  • $mentions_Serializer for a converter to parse the Response from an executed this request.

Implementation

@_i2.experimental
_i3.Request $mentions_Request({
  required String token,
  required String search,
  ChatMentionsApiVersion? apiVersion,
  int? limit,
  ChatMentionsIncludeStatus? includeStatus,
  bool? oCSAPIRequest,
}) {
  final _parameters = <String, Object?>{};
  final __token = _$jsonSerializers.serialize(token, specifiedType: const FullType(String));
  _i4.checkString(
    __token,
    'token',
    pattern: RegExp(r'^[a-z0-9]{4,30}$'),
  );
  _parameters['token'] = __token;

  final __search = _$jsonSerializers.serialize(search, specifiedType: const FullType(String));
  _parameters['search'] = __search;

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

  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;

  final _path = _i5.UriTemplate(
    '/ocs/v2.php/apps/spreed/api/{apiVersion}/chat/{token}/mentions{?search*,limit*,includeStatus*}',
  ).expand(_parameters);
  final _uri = Uri.parse('${_rootClient.baseURL}$_path');
  final _request = _i3.Request('get', _uri);
  _request.headers['Accept'] = 'application/json';
// coverage:ignore-start
  final authentication = _i6.IterableExtension(_rootClient.authentications)?.firstWhereOrNull(
    (auth) => switch (auth) {
      _i1.DynamiteHttpBearerAuthentication() || _i1.DynamiteHttpBasicAuthentication() => true,
      _ => false,
    },
  );

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

// coverage:ignore-end
  var __oCSAPIRequest = _$jsonSerializers.serialize(oCSAPIRequest, specifiedType: const FullType(bool));
  __oCSAPIRequest ??= true;
  _request.headers['OCS-APIRequest'] = const _i4.HeaderEncoder().convert(__oCSAPIRequest);

  return _request;
}