getPreviewByFileId method
Future<DynamiteResponse<Uint8List, void> >
getPreviewByFileId({
- int? fileId,
- int? x,
- int? y,
- PreviewGetPreviewByFileIdA? a,
- PreviewGetPreviewByFileIdForceIcon? forceIcon,
- String? mode,
- PreviewGetPreviewByFileIdMimeFallback? mimeFallback,
Get a preview by file ID.
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:
fileId
ID of the file. Defaults to-1
.x
Width of the preview. Defaults to32
.y
Height of the preview. Defaults to32
.a
Whether to not crop the preview. Defaults to0
.forceIcon
Force returning an icon. Defaults to1
.mode
How to crop the image. Defaults to"fill"
.mimeFallback
Whether to fallback to the mime icon if no preview is available. Defaults to0
.
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:
- $getPreviewByFileId_Request for the request send by this method.
- $getPreviewByFileId_Serializer for a converter to parse the
Response
from an executed request.
Implementation
Future<_i1.DynamiteResponse<Uint8List, void>> getPreviewByFileId({
int? fileId,
int? x,
int? y,
PreviewGetPreviewByFileIdA? a,
PreviewGetPreviewByFileIdForceIcon? forceIcon,
String? mode,
PreviewGetPreviewByFileIdMimeFallback? mimeFallback,
}) async {
final _request = $getPreviewByFileId_Request(
fileId: fileId,
x: x,
y: y,
a: a,
forceIcon: forceIcon,
mode: mode,
mimeFallback: mimeFallback,
);
final _streamedResponse = await _rootClient.httpClient.send(_request);
final _response = await _i3.Response.fromStream(_streamedResponse);
final _serializer = $getPreviewByFileId_Serializer();
return _i1.ResponseConverter<Uint8List, void>(_serializer).convert(_response);
}