getPreviewRaw method
Get the preview for a 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:
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
.
Status codes:
- 200: Preview returned
- 400: Getting preview is not possible
- 404: Preview not found
See:
- getPreview for an operation that returns a DynamiteResponse with a stable API.
Implementation
@experimental
DynamiteRawResponse<Uint8List, void> getPreviewRaw({
int? fileId,
int? x,
int? y,
int? a,
}) {
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 $fileId = jsonSerializers.serialize(fileId, specifiedType: const FullType(int));
$fileId ??= -1;
_parameters['fileId'] = $fileId;
var $x = jsonSerializers.serialize(x, specifiedType: const FullType(int));
$x ??= 32;
_parameters['x'] = $x;
var $y = jsonSerializers.serialize(y, specifiedType: const FullType(int));
$y ??= 32;
_parameters['y'] = $y;
var $a = jsonSerializers.serialize(a, specifiedType: const FullType(int));
$a ??= 0;
_parameters['a'] = $a;
final _path = UriTemplate('/index.php/apps/files_trashbin/preview{?fileId*,x*,y*,a*}').expand(_parameters);
return DynamiteRawResponse<Uint8List, void>(
response: _rootClient.executeRequest(
'get',
_path,
_headers,
null,
const {200},
),
bodyType: const FullType(Uint8List),
headersType: null,
serializers: jsonSerializers,
);
}