$translate_Request method

  1. @experimental
Request $translate_Request({
  1. required TranslationApiTranslateRequestApplicationJson $body,
  2. bool? oCSAPIRequest,
})

Translate a text.

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

Parameters:

  • oCSAPIRequest Required to be true for the API request to pass. Defaults to true.

Status codes:

  • 200: Translated text returned
  • 400: Language not detected or unable to translate
  • 412: Translating is not possible
  • 500

See:

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

Implementation

@_i2.experimental
_i3.Request $translate_Request({
  required TranslationApiTranslateRequestApplicationJson $body,
  bool? oCSAPIRequest,
}) {
  const _path = '/ocs/v2.php/translation/translate';
  final _uri = Uri.parse('${_rootClient.baseURL}$_path');
  final _request = _i3.Request('post', _uri);
  _request.headers['Accept'] = 'application/json';
// coverage:ignore-start
  final authentication = _i4.IterableExtension(_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 _i5.HeaderEncoder().convert(__oCSAPIRequest);

  _request.headers['Content-Type'] = 'application/json';
  _request.body = json.encode(
    _$jsonSerializers.serialize(
      $body,
      specifiedType: const FullType(TranslationApiTranslateRequestApplicationJson),
    ),
  );
  return _request;
}