previewRaw method

  1. @experimental
DynamiteRawResponse<Uint8List, void> previewRaw({
  1. required String referenceId,
})

Get a preview for a reference.

This method and the response it returns is experimental. The API might change without a major version bump.

Returns a Future containing a DynamiteRawResponse with the raw HttpClientResponse and serialization helpers. 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:

Implementation

@experimental
DynamiteRawResponse<Uint8List, void> previewRaw({required String referenceId}) {
  final _parameters = <String, dynamic>{};
  final _headers = <String, String>{
    'Accept': '*/*',
  };

// coverage:ignore-start
  final authentication = _rootClient.authentications.firstWhereOrNull(
    (auth) => switch (auth) {
      DynamiteHttpBearerAuthentication() || DynamiteHttpBasicAuthentication() => true,
      _ => false,
    },
  );

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

// coverage:ignore-end
  final $referenceId = jsonSerializers.serialize(referenceId, specifiedType: const FullType(String));
  _parameters['referenceId'] = $referenceId;

  final _path = UriTemplate('/index.php/core/references/preview/{referenceId}').expand(_parameters);
  return DynamiteRawResponse<Uint8List, void>(
    response: _rootClient.executeRequest(
      'get',
      _path,
      _headers,
      null,
      const {200},
    ),
    bodyType: const FullType(Uint8List),
    headersType: null,
    serializers: jsonSerializers,
  );
}