$getPreview_Request method

  1. @experimental
Request $getPreview_Request({
  1. String? file,
  2. int? x,
  3. int? y,
  4. String? version,
})

Get the preview for a file version.

Returns a DynamiteRequest backing the getPreview operation. 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 44.
  • y Height of the preview. Defaults to 44.
  • version Version of the file to get the preview for. Defaults to "".

Status codes:

  • 200: Preview returned
  • 400: Getting preview is not possible
  • 404: Preview not found

See:

  • getPreview for a method executing this request and parsing the response.
  • $getPreview_Serializer for a converter to parse the Response from an executed this request.

Implementation

@_i2.experimental
_i3.Request $getPreview_Request({
  String? file,
  int? x,
  int? y,
  String? version,
}) {
  final _parameters = <String, Object?>{};
  var $file = _$jsonSerializers.serialize(file, specifiedType: const FullType(String));
  $file ??= '';
  _parameters['file'] = $file;

  var $x = _$jsonSerializers.serialize(x, specifiedType: const FullType(int));
  $x ??= 44;
  _parameters['x'] = $x;

  var $y = _$jsonSerializers.serialize(y, specifiedType: const FullType(int));
  $y ??= 44;
  _parameters['y'] = $y;

  var $version = _$jsonSerializers.serialize(version, specifiedType: const FullType(String));
  $version ??= '';
  _parameters['version'] = $version;

  final _path = _i4.UriTemplate('/index.php/apps/files_versions/preview{?file*,x*,y*,version*}').expand(_parameters);
  final _uri = Uri.parse('${_rootClient.baseURL}$_path');
  final _request = _i3.Request('get', _uri);
  _request.headers['Accept'] = '*/*';
// coverage:ignore-start
  final authentication = _rootClient.authentications?.firstWhereOrNull(
    (auth) => switch (auth) {
      _i1.DynamiteHttpBearerAuthentication() || _i1.DynamiteHttpBasicAuthentication() => true,
      _ => false,
    },
  );

  if (authentication != null) {
    _request.headers.addAll(
      authentication.headers,
    );
  } else {
    throw Exception('Missing authentication for bearer_auth or basic_auth');
  }

// coverage:ignore-end
  return _request;
}