$$get_Request method

@experimental Request $$get_Request({ required String search, String? itemType, String? itemId, String? sorter, BuiltList<int>? shareTypes, int? limit, bool? oCSAPIRequest, })

Autocomplete a query.

Returns a DynamiteRequest backing the $get operation. Throws a DynamiteApiException if the API call does not return an expected status code.

Parameters:

• search Text to search for.
• itemType Type of the items to search for.
• itemId ID of the items to search for.
• sorter can be piped, top prio first, e.g.: "commenters|share-recipients".
• shareTypes Types of shares to search for. Defaults to [].
• limit Maximum number of results to return. Defaults to 10.
• oCSAPIRequest Required to be true for the API request to pass. Defaults to true.

Status codes:

• 200: Autocomplete results returned

See:

• $get for a method executing this request and parsing the response.
• $$get_Serializer for a converter to parse the Response from an executed this request.

Implementation

@_i2.experimental
_i3.Request $$get_Request({
  required String search,
  String? itemType,
  String? itemId,
  String? sorter,
  BuiltList<int>? shareTypes,
  int? limit,
  bool? oCSAPIRequest,
}) {
  final _parameters = <String, Object?>{};
  final $search = _$jsonSerializers.serialize(search, specifiedType: const FullType(String));
  _parameters['search'] = $search;

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

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

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

  var $shareTypes =
      _$jsonSerializers.serialize(shareTypes, specifiedType: const FullType(BuiltList, [FullType(int)]));
  $shareTypes ??= const [];
  _parameters['shareTypes%5B%5D'] = $shareTypes;

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

  final _path = _i5.UriTemplate(
    '/ocs/v2.php/core/autocomplete/get{?search*,itemType*,itemId*,sorter*,shareTypes%5B%5D*,limit*}',
  ).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 = _rootClient.authentications?.firstWhereOrNull(
    (auth) => switch (auth) {
      _i1.DynamiteHttpBearerAuthentication() || _i1.DynamiteHttpBasicAuthentication() => true,
      _ => false,
    },
  );

  if (authentication != null) {
    _request.headers.addAll(
      authentication.headers,
    );
  } else {
    throw Exception('Missing authentication for bearer_auth or basic_auth');
  }

// 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;
}