list method

Future<Volumes> list({
  1. String? locale,
  2. int? maxResults,
  3. List<String>? processingState,
  4. String? source,
  5. int? startIndex,
  6. List<String>? volumeId,
  7. String? $fields,
})

Return a list of books uploaded by the current user.

Request parameters:

locale - ISO-639-1 language and ISO-3166-1 country code. Ex: 'en_US'. Used for generating recommendations.

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

processingState - The processing state of the user uploaded volumes to be returned.

source - String to identify the originator of this request.

startIndex - Index of the first result to return (starts at 0)

volumeId - The ids of the volumes to be returned. If not specified all that match the processingState are returned.

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

Completes with a Volumes.

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<Volumes> list({
  core.String? locale,
  core.int? maxResults,
  core.List<core.String>? processingState,
  core.String? source,
  core.int? startIndex,
  core.List<core.String>? volumeId,
  core.String? $fields,
}) async {
  final queryParams_ = <core.String, core.List<core.String>>{
    if (locale != null) 'locale': [locale],
    if (maxResults != null) 'maxResults': ['${maxResults}'],
    if (processingState != null) 'processingState': processingState,
    if (source != null) 'source': [source],
    if (startIndex != null) 'startIndex': ['${startIndex}'],
    if (volumeId != null) 'volumeId': volumeId,
    if ($fields != null) 'fields': [$fields],
  };

  const url_ = 'books/v1/volumes/useruploaded';

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