themeSlideThumbnailGet method

Future<Uint8List> themeSlideThumbnailGet(
  1. String id, {
  2. String? themeSlide,
  3. int? quality,
})
inherited

themeSlideThumbnailGet -> /v1/theme/{id}/slides/{theme_slide}/thumbnail

Requests a thumbnail image of the specified theme slide at the given quality value.

PARAMETERS

id : The ID of the theme, either name or index.

  • Example (by_name): Theme Name
  • Example (by_index): 3

themeSlide : The ID of the theme slide, either name, index or UUID.

  • Example (by_name): Theme Slide Name
  • Example (by_index): 3
  • Example (by_uuid): 3C39C433-5C18-4F51-B357-55BB870227C4

quality : The desired quality of the thumbnail. The value is the number of pixels in the largest dimension of the image, i.e. if the image is landscape (wider than it is tall), it is the width of the image. If the image is portrait (taller than it is wide), it is the height of the image.

Example: 400

RESPONSE 200:

The request was processed successfully.

content-type: image/jpeg

schema:

{
  "type": "string",
  "required": [],
  "format": "binary",
  "example": "image data here"
}

Implementation

Future<Uint8List> themeSlideThumbnailGet(String id, {String? themeSlide, int? quality}) async {
  String url = '/v1/theme/$id/slides/$themeSlide/thumbnail';
  Map<String, dynamic> query = {'quality': quality.toString()};

  return await call('get', url, params: query, httpAccept: 'image/jpeg');
}