getFileContents method

Future<DynamiteResponse<Uint8List, void>> getFileContents({ required int taskId, required int fileId, bool? oCSAPIRequest, })

Returns the contents of a file referenced in a task.

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:

• taskId The id of the task.
• fileId The file id of the file to retrieve.
• oCSAPIRequest Required to be true for the API request to pass. Defaults to true.

Status codes:

• 200: File content returned
• 500
• 404: Task or file not found

See:

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

Implementation

Future<_i1.DynamiteResponse<Uint8List, void>> getFileContents({
  required int taskId,
  required int fileId,
  bool? oCSAPIRequest,
}) async {
  final _request = $getFileContents_Request(
    taskId: taskId,
    fileId: fileId,
    oCSAPIRequest: oCSAPIRequest,
  );
  final _streamedResponse = await _rootClient.httpClient.send(_request);
  final _response = await _i3.Response.fromStream(_streamedResponse);

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