getShare method

Future<DynamiteResponse<ShareapiGetShareResponseApplicationJson, void>> getShare({
  1. required String id,
  2. int? includeTags,
  3. bool? oCSAPIRequest,
})

Get a specific share by id.

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:

  • includeTags Include tags in the share. Defaults to 0.
  • id ID of the share.
  • oCSAPIRequest Required to be true for the API request to pass. Defaults to true.

Status codes:

  • 200: Share returned
  • 404: Share not found

See:

Implementation

Future<DynamiteResponse<ShareapiGetShareResponseApplicationJson, void>> getShare({
  required String id,
  int? includeTags,
  bool? oCSAPIRequest,
}) async {
  final rawResponse = getShareRaw(
    id: id,
    includeTags: includeTags,
    oCSAPIRequest: oCSAPIRequest,
  );

  return rawResponse.future;
}