getPreviewRaw method

  1. @experimental
DynamiteRawResponse<Uint8List, void> getPreviewRaw({
  1. String? file,
  2. int? x,
  3. int? y,
  4. String? version,
})

Get the preview for a file version.

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:

  • file Path of the file. Defaults to ''.
  • x Width of the preview. Defaults to 44.
  • y Height of the preview. Defaults to 44.
  • version Version of the file to get the preview for. Defaults to ''.

Status codes:

  • 200: Preview returned
  • 400: Getting preview is not possible
  • 404: Preview not found

See:

Implementation

@experimental
DynamiteRawResponse<Uint8List, void> getPreviewRaw({
  String? file,
  int? x,
  int? y,
  String? version,
}) {
  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,
    );
  } else {
    throw Exception('Missing authentication for bearer_auth or basic_auth');
  }

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

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

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

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

  final _path = UriTemplate('/index.php/apps/files_versions/preview{?file*,x*,y*,version*}').expand(_parameters);
  return DynamiteRawResponse<Uint8List, void>(
    response: _rootClient.executeRequest(
      'get',
      _path,
      _headers,
      null,
      const {200},
    ),
    bodyType: const FullType(Uint8List),
    headersType: null,
    serializers: jsonSerializers,
  );
}