getUrl method

Future<DynamiteResponse<DirectGetUrlResponseApplicationJson, void>> getUrl({
  1. required int fileId,
  2. required int expirationTime,
  3. 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:

  • getUrlRaw for an experimental operation that returns a DynamiteRawResponse that can be serialized.

Implementation

Future<_i1.DynamiteResponse<DirectGetUrlResponseApplicationJson, void>> getUrl({
  required int fileId,
  required int expirationTime,
  bool? oCSAPIRequest,
}) async {
  final rawResponse = getUrlRaw(
    fileId: fileId,
    expirationTime: expirationTime,
    oCSAPIRequest: oCSAPIRequest,
  );

  return rawResponse.future;
}