getUrl method

Future<DynamiteResponse<DirectGetUrlResponseApplicationJson, void>> getUrl({ required int fileId, required int expirationTime, bool? oCSAPIRequest, })

Get a direct link to a file.

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:

• fileId ID of the file.
• expirationTime Duration until the link expires.
• oCSAPIRequest Required to be true for the API request to pass. Defaults to true.

Status codes:

• 200: Direct link returned
• 404: File not found
• 400: Getting direct link is not possible
• 403: Missing permissions to get direct link

See:

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

Implementation

Future<_i1.DynamiteResponse<DirectGetUrlResponseApplicationJson, void>> getUrl({
  required int fileId,
  required int expirationTime,
  bool? oCSAPIRequest,
}) async {
  final _request = $getUrl_Request(
    fileId: fileId,
    expirationTime: expirationTime,
    oCSAPIRequest: oCSAPIRequest,
  );
  final _response = await _rootClient.httpClient.send(_request);

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