getShares method

Future<DynamiteResponse<ShareapiGetSharesResponseApplicationJson, void>> getShares({ String? sharedWithMe, String? reshares, String? subfiles, String? path, String? includeTags, 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:

• $getShares_Request for the request send by this method.
• $getShares_Serializer for a converter to parse the Response from an executed request.

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 _response = await _rootClient.httpClient.send(_request);

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