$schedule_Request method

  1. @experimental
Request $schedule_Request({
  1. required String input,
  2. required String appId,
  3. String? identifier,
  4. int? numberOfImages,
  5. bool? oCSAPIRequest,
})

This endpoint allows scheduling a text to image task.

Returns a DynamiteRequest backing the schedule operation. Throws a DynamiteApiException if the API call does not return an expected status code.

Parameters:

  • input Input text.
  • appId ID of the app that will execute the task.
  • identifier An arbitrary identifier for the task. Defaults to "".
  • numberOfImages The number of images to generate. Defaults to 8.
  • oCSAPIRequest Required to be true for the API request to pass. Defaults to true.

Status codes:

  • 200: Task scheduled successfully
  • 412: Scheduling task is not possible
  • 500

See:

  • schedule for a method executing this request and parsing the response.
  • $schedule_Serializer for a converter to parse the Response from an executed this request.

Implementation

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

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

  var $identifier = _$jsonSerializers.serialize(identifier, specifiedType: const FullType(String));
  $identifier ??= '';
  _parameters['identifier'] = $identifier;

  var $numberOfImages = _$jsonSerializers.serialize(numberOfImages, specifiedType: const FullType(int));
  $numberOfImages ??= 8;
  _parameters['numberOfImages'] = $numberOfImages;

  final _path = _i5.UriTemplate('/ocs/v2.php/text2image/schedule{?input*,appId*,identifier*,numberOfImages*}')
      .expand(_parameters);
  final _uri = Uri.parse('${_rootClient.baseURL}$_path');
  final _request = _i3.Request('post', _uri);
  _request.headers['Accept'] = 'application/json';
// 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;
}