$extract_Request method

  1. @experimental
Request $extract_Request({
  1. required String text,
  2. ReferenceApiExtractResolve? resolve,
  3. int? limit,
  4. bool? oCSAPIRequest,
})

Extract references from a text.

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

Parameters:

  • text Text to extract from.
  • resolve Resolve the references. Defaults to 0.
  • limit Maximum amount of references to extract. Defaults to 1.
  • oCSAPIRequest Required to be true for the API request to pass. Defaults to true.

Status codes:

  • 200: References returned

See:

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

Implementation

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

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

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

  final _path = _i5.UriTemplate('/ocs/v2.php/references/extract{?text*,resolve*,limit*}').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,
    );
  } else {
    throw Exception('Missing authentication for bearer_auth or basic_auth');
  }

// 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;
}