getThumbnailRaw method

  1. @experimental
DynamiteRawResponse<Uint8List, void> getThumbnailRaw({
  1. required int x,
  2. required int y,
  3. required String file,
})

Gets a thumbnail of the specified file.

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:

  • x Width of the thumbnail.
  • y Height of the thumbnail.
  • file URL-encoded filename.

Status codes:

  • 200: Thumbnail returned
  • 400: Getting thumbnail is not possible
  • 404: File not found

See:

Implementation

@experimental
DynamiteRawResponse<Uint8List, void> getThumbnailRaw({
  required int x,
  required int y,
  required String file,
}) {
  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
  final $x = jsonSerializers.serialize(x, specifiedType: const FullType(int));
  _parameters['x'] = $x;

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

  final $file = jsonSerializers.serialize(file, specifiedType: const FullType(String));
  dynamite_utils.checkPattern($file as String?, RegExp(r'^.+$'), 'file');
  _parameters['file'] = $file;

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