getShares method

Future<DynamiteResponse<ShareapiGetSharesResponseApplicationJson, void>> getShares({
  1. String? sharedWithMe,
  2. String? reshares,
  3. String? subfiles,
  4. String? path,
  5. String? includeTags,
  6. bool? oCSAPIRequest,
})

Get shares of the current user.

Returns a Future containing a DynamiteResponse with the status code, deserialized body and headers. 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:

Implementation

Future<_i1.DynamiteResponse<ShareapiGetSharesResponseApplicationJson, void>> getShares({
  String? sharedWithMe,
  String? reshares,
  String? subfiles,
  String? path,
  String? includeTags,
  bool? oCSAPIRequest,
}) async {
  final _request = $getShares_Request(
    sharedWithMe: sharedWithMe,
    reshares: reshares,
    subfiles: subfiles,
    path: path,
    includeTags: includeTags,
    oCSAPIRequest: oCSAPIRequest,
  );
  final _streamedResponse = await _rootClient.httpClient.send(_request);
  final _response = await _i3.Response.fromStream(_streamedResponse);

  final _serializer = $getShares_Serializer();
  return _i1.ResponseConverter<ShareapiGetSharesResponseApplicationJson, void>(_serializer).convert(_response);
}