getShare method

Future<DynamiteResponse<ShareapiGetShareResponseApplicationJson, void>> getShare({ required String id, ShareapiGetShareIncludeTags? includeTags, 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:

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

Status codes:

• 200: Share returned
• 404: Share not found

See:

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

Implementation

Future<_i1.DynamiteResponse<ShareapiGetShareResponseApplicationJson, void>> getShare({
  required String id,
  ShareapiGetShareIncludeTags? includeTags,
  bool? oCSAPIRequest,
}) async {
  final _request = $getShare_Request(
    id: id,
    includeTags: includeTags,
    oCSAPIRequest: oCSAPIRequest,
  );
  final _streamedResponse = await _rootClient.httpClient.send(_request);
  final _response = await _i3.Response.fromStream(_streamedResponse);

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