getImageRaw method

  1. @experimental
DynamiteRawResponse<Uint8List, void> getImageRaw({
  1. required int id,
  2. required int index,
  3. bool? oCSAPIRequest,
})

This endpoint allows downloading the resulting image of a task.

This method and the response it returns is experimental. The API might change without a major version bump.

Returns a Future containing a DynamiteRawResponse with the raw HttpClientResponse and serialization helpers. 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:

Implementation

@experimental
DynamiteRawResponse<Uint8List, void> getImageRaw({
  required int id,
  required int index,
  bool? oCSAPIRequest,
}) {
  final _parameters = <String, dynamic>{};
  final _headers = <String, String>{
    'Accept': '*/*',
  };

// coverage:ignore-start
  final authentication = _rootClient.authentications.firstWhereOrNull(
    (auth) => switch (auth) {
      DynamiteHttpBearerAuthentication() || DynamiteHttpBasicAuthentication() => true,
      _ => false,
    },
  );

  if (authentication != null) {
    _headers.addAll(
      authentication.headers,
    );
  }

// coverage:ignore-end
  final $id = jsonSerializers.serialize(id, specifiedType: const FullType(int));
  _parameters['id'] = $id;

  final $index = jsonSerializers.serialize(index, specifiedType: const FullType(int));
  _parameters['index'] = $index;

  var $oCSAPIRequest = jsonSerializers.serialize(oCSAPIRequest, specifiedType: const FullType(bool));
  $oCSAPIRequest ??= true;
  _headers['OCS-APIRequest'] = const dynamite_utils.HeaderEncoder().convert($oCSAPIRequest);

  final _path = UriTemplate('/ocs/v2.php/text2image/task/{id}/image/{index}').expand(_parameters);
  return DynamiteRawResponse<Uint8List, void>(
    response: _rootClient.executeRequest(
      'get',
      _path,
      _headers,
      null,
      const {200},
    ),
    bodyType: const FullType(Uint8List),
    headersType: null,
    serializers: jsonSerializers,
  );
}