getImage method

Future<DynamiteResponse<Uint8List, void>> getImage({ required int id, required int index, bool? oCSAPIRequest, })

This endpoint allows downloading the resulting image of 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:

• id The id of the task.
• index The index of the image to retrieve.
• oCSAPIRequest Required to be true for the API request to pass. Defaults to true.

Status codes:

• 200: Image returned
• 404: Task or image not found
• 500

See:

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

Implementation

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

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