$getShares_Request method

@experimental Request $getShares_Request({ String? sharedWithMe, String? reshares, String? subfiles, String? path, String? includeTags, bool? oCSAPIRequest, })

Get shares of the current user.

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

Parameters:

• sharedWithMe Only get shares with the current user. Defaults to "false".
• reshares Only get shares by the current user and reshares. Defaults to "false".
• subfiles Only get all shares in a folder. Defaults to "false".
• path Get shares for a specific path. Defaults to "".
• includeTags Include tags in the share. Defaults to "false".
• oCSAPIRequest Required to be true for the API request to pass. Defaults to true.

Status codes:

• 200: Shares returned
• 404: The folder was not found or is inaccessible

See:

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

Implementation

@_i2.experimental
_i3.Request $getShares_Request({
  String? sharedWithMe,
  String? reshares,
  String? subfiles,
  String? path,
  String? includeTags,
  bool? oCSAPIRequest,
}) {
  final _parameters = <String, Object?>{};
  var $sharedWithMe = _$jsonSerializers.serialize(sharedWithMe, specifiedType: const FullType(String));
  $sharedWithMe ??= 'false';
  _parameters['shared_with_me'] = $sharedWithMe;

  var $reshares = _$jsonSerializers.serialize(reshares, specifiedType: const FullType(String));
  $reshares ??= 'false';
  _parameters['reshares'] = $reshares;

  var $subfiles = _$jsonSerializers.serialize(subfiles, specifiedType: const FullType(String));
  $subfiles ??= 'false';
  _parameters['subfiles'] = $subfiles;

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

  var $includeTags = _$jsonSerializers.serialize(includeTags, specifiedType: const FullType(String));
  $includeTags ??= 'false';
  _parameters['include_tags'] = $includeTags;

  final _path = _i5.UriTemplate(
    '/ocs/v2.php/apps/files_sharing/api/v1/shares{?shared_with_me*,reshares*,subfiles*,path*,include_tags*}',
  ).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;
}