$search_Request method

  1. @experimental
Request $search_Request({
  1. String? search,
  2. String? itemType,
  3. int? page,
  4. int? perPage,
  5. ShareesapiSearchShareType? shareType,
  6. ShareesapiSearchLookup? lookup,
  7. bool? oCSAPIRequest,
})

Search for sharees.

Returns a DynamiteRequest backing the search operation. 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:

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

Implementation

@_i2.experimental
_i3.Request $search_Request({
  String? search,
  String? itemType,
  int? page,
  int? perPage,
  ShareesapiSearchShareType? shareType,
  ShareesapiSearchLookup? lookup,
  bool? oCSAPIRequest,
}) {
  final _parameters = <String, Object?>{};
  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(ShareesapiSearchLookup));
  $lookup ??= 0;
  _parameters['lookup'] = $lookup;

  final _path = _i5.UriTemplate(
    '/ocs/v2.php/apps/files_sharing/api/v1/sharees{?search*,itemType*,page*,perPage*,shareType*,lookup*}',
  ).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;
}