getPreview method

Future<DynamiteResponse<Uint8List, void>> getPreview({
  1. String? file,
  2. int? x,
  3. int? y,
  4. PreviewGetPreviewA? a,
  5. PreviewGetPreviewForceIcon? forceIcon,
  6. String? mode,
  7. PreviewGetPreviewMimeFallback? mimeFallback,
})

Get a preview by file path.

Returns a Future containing a DynamiteResponse with the status code, deserialized body and headers. 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 32.
  • y Height of the preview. Defaults to 32.
  • a Whether to not crop the preview. Defaults to 0.
  • forceIcon Force returning an icon. Defaults to 1.
  • mode How to crop the image. Defaults to "fill".
  • mimeFallback Whether to fallback to the mime icon if no preview is available. Defaults to 0.

Status codes:

  • 200: Preview returned
  • 400: Getting preview is not possible
  • 403: Getting preview is not allowed
  • 404: Preview not found
  • 303: Redirect to the mime icon url if mimeFallback is true

See:

Implementation

Future<_i1.DynamiteResponse<Uint8List, void>> getPreview({
  String? file,
  int? x,
  int? y,
  PreviewGetPreviewA? a,
  PreviewGetPreviewForceIcon? forceIcon,
  String? mode,
  PreviewGetPreviewMimeFallback? mimeFallback,
}) async {
  final _request = $getPreview_Request(
    file: file,
    x: x,
    y: y,
    a: a,
    forceIcon: forceIcon,
    mode: mode,
    mimeFallback: mimeFallback,
  );
  final _response = await _rootClient.httpClient.send(_request);

  final _serializer = $getPreview_Serializer();
  final _rawResponse = await _i1.ResponseConverter<Uint8List, void>(_serializer).convert(_response);
  return _i1.DynamiteResponse.fromRawResponse(_rawResponse);
}