source: vendor/google/apiclient-services/src/Books/Resource/BookshelvesVolumes.php

Last change on this file was e3d4e0a, checked in by Vlado 222039 <vlado.popovski@…>, 2 weeks ago

Upload project files

  • Property mode set to 100644
File size: 2.1 KB
Line 
1<?php
2/*
3 * Copyright 2014 Google Inc.
4 *
5 * Licensed under the Apache License, Version 2.0 (the "License"); you may not
6 * use this file except in compliance with the License. You may obtain a copy of
7 * the License at
8 *
9 * http://www.apache.org/licenses/LICENSE-2.0
10 *
11 * Unless required by applicable law or agreed to in writing, software
12 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
13 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
14 * License for the specific language governing permissions and limitations under
15 * the License.
16 */
17
18namespace Google\Service\Books\Resource;
19
20use Google\Service\Books\Volumes as VolumesModel;
21
22/**
23 * The "volumes" collection of methods.
24 * Typical usage is:
25 * <code>
26 * $booksService = new Google\Service\Books(...);
27 * $volumes = $booksService->bookshelves_volumes;
28 * </code>
29 */
30class BookshelvesVolumes extends \Google\Service\Resource
31{
32 /**
33 * Retrieves volumes in a specific bookshelf for the specified user.
34 * (volumes.listBookshelvesVolumes)
35 *
36 * @param string $userId ID of user for whom to retrieve bookshelf volumes.
37 * @param string $shelf ID of bookshelf to retrieve volumes.
38 * @param array $optParams Optional parameters.
39 *
40 * @opt_param string maxResults Maximum number of results to return
41 * @opt_param bool showPreorders Set to true to show pre-ordered books. Defaults
42 * to false.
43 * @opt_param string source String to identify the originator of this request.
44 * @opt_param string startIndex Index of the first element to return (starts at
45 * 0)
46 * @return VolumesModel
47 * @throws \Google\Service\Exception
48 */
49 public function listBookshelvesVolumes($userId, $shelf, $optParams = [])
50 {
51 $params = ['userId' => $userId, 'shelf' => $shelf];
52 $params = array_merge($params, $optParams);
53 return $this->call('list', [$params], VolumesModel::class);
54 }
55}
56
57// Adding a class alias for backwards compatibility with the previous class name.
58class_alias(BookshelvesVolumes::class, 'Google_Service_Books_Resource_BookshelvesVolumes');
Note: See TracBrowser for help on using the repository browser.