list method

Future<Annotationsdata> list(String volumeId, String layerId, String contentVersion, { List<String>? annotationDataId, int? h, String? locale, int? maxResults, String? pageToken, int? scale, String? source, String? updatedMax, String? updatedMin, int? w, String? $fields, })

Gets the annotation data for a volume and layer.

Request parameters:

volumeId - The volume to retrieve annotation data for.

layerId - The ID for the layer to get the annotation data.

contentVersion - The content version for the requested volume.

annotationDataId - The list of Annotation Data Ids to retrieve. Pagination is ignored if this is set.

h - The requested pixel height for any images. If height is provided width must also be provided.

locale - The locale information for the data. ISO-639-1 language and ISO-3166-1 country code. Ex: 'en_US'.

maxResults - Maximum number of results to return Value must be between "0" and "200".

pageToken - The value of the nextToken from the previous page.

scale - The requested scale for the image.

source - String to identify the originator of this request.

updatedMax - RFC 3339 timestamp to restrict to items updated prior to this timestamp (exclusive).

updatedMin - RFC 3339 timestamp to restrict to items updated since this timestamp (inclusive).

w - The requested pixel width for any images. If width is provided height must also be provided.

$fields - Selector specifying which fields to include in a partial response.

Completes with a Annotationsdata.

Completes with a commons.ApiRequestError if the API endpoint returned an error.

If the used http.Client completes with an error when making a REST call, this method will complete with the same error.

Implementation

async.Future<Annotationsdata> list(
  core.String volumeId,
  core.String layerId,
  core.String contentVersion, {
  core.List<core.String>? annotationDataId,
  core.int? h,
  core.String? locale,
  core.int? maxResults,
  core.String? pageToken,
  core.int? scale,
  core.String? source,
  core.String? updatedMax,
  core.String? updatedMin,
  core.int? w,
  core.String? $fields,
}) async {
  final queryParams_ = <core.String, core.List<core.String>>{
    'contentVersion': [contentVersion],
    if (annotationDataId != null) 'annotationDataId': annotationDataId,
    if (h != null) 'h': ['${h}'],
    if (locale != null) 'locale': [locale],
    if (maxResults != null) 'maxResults': ['${maxResults}'],
    if (pageToken != null) 'pageToken': [pageToken],
    if (scale != null) 'scale': ['${scale}'],
    if (source != null) 'source': [source],
    if (updatedMax != null) 'updatedMax': [updatedMax],
    if (updatedMin != null) 'updatedMin': [updatedMin],
    if (w != null) 'w': ['${w}'],
    if ($fields != null) 'fields': [$fields],
  };

  final url_ = 'books/v1/volumes/' +
      commons.escapeVariable('$volumeId') +
      '/layers/' +
      commons.escapeVariable('$layerId') +
      '/data';

  final response_ = await _requester.request(
    url_,
    'GET',
    queryParams: queryParams_,
  );
  return Annotationsdata.fromJson(
      response_ as core.Map<core.String, core.dynamic>);
}