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

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

Upload project files

  • Property mode set to 100644
File size: 2.4 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\Bookshelf;
21use Google\Service\Books\Bookshelves as BookshelvesModel;
22
23/**
24 * The "bookshelves" collection of methods.
25 * Typical usage is:
26 * <code>
27 * $booksService = new Google\Service\Books(...);
28 * $bookshelves = $booksService->bookshelves;
29 * </code>
30 */
31class Bookshelves extends \Google\Service\Resource
32{
33 /**
34 * Retrieves metadata for a specific bookshelf for the specified user.
35 * (bookshelves.get)
36 *
37 * @param string $userId ID of user for whom to retrieve bookshelves.
38 * @param string $shelf ID of bookshelf to retrieve.
39 * @param array $optParams Optional parameters.
40 *
41 * @opt_param string source String to identify the originator of this request.
42 * @return Bookshelf
43 * @throws \Google\Service\Exception
44 */
45 public function get($userId, $shelf, $optParams = [])
46 {
47 $params = ['userId' => $userId, 'shelf' => $shelf];
48 $params = array_merge($params, $optParams);
49 return $this->call('get', [$params], Bookshelf::class);
50 }
51 /**
52 * Retrieves a list of public bookshelves for the specified user.
53 * (bookshelves.listBookshelves)
54 *
55 * @param string $userId ID of user for whom to retrieve bookshelves.
56 * @param array $optParams Optional parameters.
57 *
58 * @opt_param string source String to identify the originator of this request.
59 * @return BookshelvesModel
60 * @throws \Google\Service\Exception
61 */
62 public function listBookshelves($userId, $optParams = [])
63 {
64 $params = ['userId' => $userId];
65 $params = array_merge($params, $optParams);
66 return $this->call('list', [$params], BookshelvesModel::class);
67 }
68}
69
70// Adding a class alias for backwards compatibility with the previous class name.
71class_alias(Bookshelves::class, 'Google_Service_Books_Resource_Bookshelves');
Note: See TracBrowser for help on using the repository browser.