getSharesRaw method

  1. @experimental
DynamiteRawResponse<ShareapiGetSharesResponseApplicationJson, void> getSharesRaw({
  1. String? sharedWithMe,
  2. String? reshares,
  3. String? subfiles,
  4. String? path,
  5. String? includeTags,
  6. bool? oCSAPIRequest,
})

Get shares of the current user.

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:

  • 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 an operation that returns a DynamiteResponse with a stable API.

Implementation

@_i4.experimental
_i1.DynamiteRawResponse<ShareapiGetSharesResponseApplicationJson, void> getSharesRaw({
  String? sharedWithMe,
  String? reshares,
  String? subfiles,
  String? path,
  String? includeTags,
  bool? oCSAPIRequest,
}) {
  final _parameters = <String, dynamic>{};
  final _headers = <String, String>{'Accept': 'application/json'};

// coverage:ignore-start
  final authentication = _rootClient.authentications?.firstWhereOrNull(
    (auth) => switch (auth) {
      _i1.DynamiteHttpBearerAuthentication() || _i1.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 $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;

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

  final _path = _i3.UriTemplate(
    '/ocs/v2.php/apps/files_sharing/api/v1/shares{?shared_with_me*,reshares*,subfiles*,path*,include_tags*}',
  ).expand(_parameters);
  return _i1.DynamiteRawResponse<ShareapiGetSharesResponseApplicationJson, void>(
    response: _rootClient.executeRequest(
      'get',
      _path,
      headers: _headers,
      validStatuses: const {200},
    ),
    bodyType: const FullType(ShareapiGetSharesResponseApplicationJson),
    headersType: null,
    serializers: _$jsonSerializers,
  );
}