getPreview method

Future<DynamiteResponse<Uint8List, void>> getPreview({ required String token, String? file, int? x, int? y, PublicPreviewGetPreviewA? a, PublicPreviewGetPreviewMimeFallback? mimeFallback, })

Get a preview for a shared file.

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:

• token Token of the share.
• file File in the share. 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.
• 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: Share or preview not found
• 303: Redirect to the mime icon url if mimeFallback is true

See:

• $getPreview_Request for the request send by this method.
• $getPreview_Serializer for a converter to parse the Response from an executed request.

Implementation

Future<_i1.DynamiteResponse<Uint8List, void>> getPreview({
  required String token,
  String? file,
  int? x,
  int? y,
  PublicPreviewGetPreviewA? a,
  PublicPreviewGetPreviewMimeFallback? mimeFallback,
}) async {
  final _request = $getPreview_Request(token: token, file: file, x: x, y: y, a: a, mimeFallback: mimeFallback);
  final _streamedResponse = await _rootClient.httpClient.send(_request);
  final _response = await _i3.Response.fromStream(_streamedResponse);

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