list method

Future<GoogleExampleLibraryagentV1ListBooksResponse> list(
  1. String parent, {
  2. int? pageSize,
  3. String? pageToken,
  4. String? $fields,
})

Lists books in a shelf.

The order is unspecified but deterministic. Newly created books will not necessarily be added to the end of this list. Returns NOT_FOUND if the shelf does not exist.

Request parameters:

parent - Required. The name of the shelf whose books we'd like to list. Value must have pattern ^shelves/\[^/\]+$.

pageSize - Requested page size. Server may return fewer books than requested. If unspecified, server will pick an appropriate default.

pageToken - A token identifying a page of results the server should return. Typically, this is the value of ListBooksResponse.next_page_token. returned from the previous call to ListBooks method.

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

Completes with a GoogleExampleLibraryagentV1ListBooksResponse.

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<GoogleExampleLibraryagentV1ListBooksResponse> list(
  core.String parent, {
  core.int? pageSize,
  core.String? pageToken,
  core.String? $fields,
}) async {
  final queryParams_ = <core.String, core.List<core.String>>{
    if (pageSize != null) 'pageSize': ['${pageSize}'],
    if (pageToken != null) 'pageToken': [pageToken],
    if ($fields != null) 'fields': [$fields],
  };

  final url_ = 'v1/' + core.Uri.encodeFull('$parent') + '/books';

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