$preview_Request method

  1. @experimental
Request $preview_Request({
  1. required String referenceId,
})

Get a preview for a reference.

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

Parameters:

  • referenceId the reference cache key.

Status codes:

  • 200: Preview returned
  • 404: Reference not found

See:

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

Implementation

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

  final _path = _i5.UriTemplate('/index.php/core/references/preview/{referenceId}').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
  return _request;
}