searchRaw method

  1. @experimental
DynamiteRawResponse<ShareesapiSearchResponseApplicationJson, ShareesapiShareesapiSearchHeaders> searchRaw({
  1. String? search,
  2. String? itemType,
  3. int? page,
  4. int? perPage,
  5. ShareesapiSearchShareType? shareType,
  6. int? lookup,
  7. bool? oCSAPIRequest,
})

Search for sharees.

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. Defaults to ''.
  • itemType Limit to specific item types.
  • page Page offset for searching. Defaults to 1.
  • perPage Limit amount of search results per page. Defaults to 200.
  • shareType Limit to specific share types.
  • lookup If a global lookup should be performed too. Defaults to 0.
  • oCSAPIRequest Required to be true for the API request to pass. Defaults to true.

Status codes:

  • 200: Sharees search result returned
  • 400: Invalid search parameters

See:

Implementation

@experimental
DynamiteRawResponse<ShareesapiSearchResponseApplicationJson, ShareesapiShareesapiSearchHeaders> searchRaw({
  String? search,
  String? itemType,
  int? page,
  int? perPage,
  ShareesapiSearchShareType? shareType,
  int? lookup,
  bool? oCSAPIRequest,
}) {
  final _parameters = <String, dynamic>{};
  final _headers = <String, String>{
    'Accept': 'application/json',
  };

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

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

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

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

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

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

  final $shareType = jsonSerializers.serialize(shareType, specifiedType: const FullType(ShareesapiSearchShareType));
  _parameters['shareType'] = $shareType;

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

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

  final _path = UriTemplate(
    '/ocs/v2.php/apps/files_sharing/api/v1/sharees{?search*,itemType*,page*,perPage*,shareType*,lookup*}',
  ).expand(_parameters);
  return DynamiteRawResponse<ShareesapiSearchResponseApplicationJson, ShareesapiShareesapiSearchHeaders>(
    response: _rootClient.executeRequest(
      'get',
      _path,
      _headers,
      null,
      const {200},
    ),
    bodyType: const FullType(ShareesapiSearchResponseApplicationJson),
    headersType: const FullType(ShareesapiShareesapiSearchHeaders),
    serializers: jsonSerializers,
  );
}