$getImage_Request method

@experimental Request $getImage_Request({ required int id, required int index, bool? oCSAPIRequest, })

This endpoint allows downloading the resulting image of a task.

Returns a DynamiteRequest backing the getImage operation. 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 for a method executing this request and parsing the response.
• $getImage_Serializer for a converter to parse the Response from an executed this request.

Implementation

@_i2.experimental
_i3.Request $getImage_Request({
  required int id,
  required int index,
  bool? oCSAPIRequest,
}) {
  final _parameters = <String, Object?>{};
  final $id = _$jsonSerializers.serialize(id, specifiedType: const FullType(int));
  _parameters['id'] = $id;

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

  final _path = _i5.UriTemplate('/ocs/v2.php/text2image/task/{id}/image/{index}').expand(_parameters);
  final _uri = Uri.parse('${_rootClient.baseURL}$_path');
  final _request = _i3.Request('get', _uri);
  _request.headers['Accept'] = '*/*';
// coverage:ignore-start
  final authentication = _rootClient.authentications?.firstWhereOrNull(
    (auth) => switch (auth) {
      _i1.DynamiteHttpBearerAuthentication() || _i1.DynamiteHttpBasicAuthentication() => true,
      _ => false,
    },
  );

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

// coverage:ignore-end
  var $oCSAPIRequest = _$jsonSerializers.serialize(oCSAPIRequest, specifiedType: const FullType(bool));
  $oCSAPIRequest ??= true;
  _request.headers['OCS-APIRequest'] = const _i4.HeaderEncoder().convert($oCSAPIRequest);

  return _request;
}