getInheritedShares method

Future<DynamiteResponse<ShareapiGetInheritedSharesResponseApplicationJson, void>> getInheritedShares({
  1. required String path,
  2. bool? oCSAPIRequest,
})

Get all shares relative to a file, including parent folders shares rights.

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:

  • path Path all shares will be relative to.
  • oCSAPIRequest Required to be true for the API request to pass. Defaults to true.

Status codes:

  • 200: Shares returned
  • 500
  • 404: The given path is invalid

See:

Implementation

Future<DynamiteResponse<ShareapiGetInheritedSharesResponseApplicationJson, void>> getInheritedShares({
  required String path,
  bool? oCSAPIRequest,
}) async {
  final rawResponse = getInheritedSharesRaw(
    path: path,
    oCSAPIRequest: oCSAPIRequest,
  );

  return rawResponse.future;
}