| Server IP : 78.140.185.180 / Your IP : 18.116.23.178 Web Server : LiteSpeed System : Linux cpanel13.v.fozzy.com 4.18.0-513.11.1.lve.el8.x86_64 #1 SMP Thu Jan 18 16:21:02 UTC 2024 x86_64 User : builderbox ( 1072) PHP Version : 7.3.33 Disable Function : NONE MySQL : OFF | cURL : ON | WGET : ON | Perl : ON | Python : ON | Sudo : OFF | Pkexec : OFF Directory : /home/builderbox/www/vendor/google/apiclient-services/src/Books/Resource/ |
Upload File : |
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\Books\Resource;
use Google\Service\Books\BooksEmpty;
use Google\Service\Books\Bookshelf;
use Google\Service\Books\Bookshelves as BookshelvesModel;
/**
* The "bookshelves" collection of methods.
* Typical usage is:
* <code>
* $booksService = new Google\Service\Books(...);
* $bookshelves = $booksService->bookshelves;
* </code>
*/
class MylibraryBookshelves extends \Google\Service\Resource
{
/**
* Adds a volume to a bookshelf. (bookshelves.addVolume)
*
* @param string $shelf ID of bookshelf to which to add a volume.
* @param string $volumeId ID of volume to add.
* @param array $optParams Optional parameters.
*
* @opt_param string reason The reason for which the book is added to the
* library.
* @opt_param string source String to identify the originator of this request.
* @return BooksEmpty
*/
public function addVolume($shelf, $volumeId, $optParams = [])
{
$params = ['shelf' => $shelf, 'volumeId' => $volumeId];
$params = array_merge($params, $optParams);
return $this->call('addVolume', [$params], BooksEmpty::class);
}
/**
* Clears all volumes from a bookshelf. (bookshelves.clearVolumes)
*
* @param string $shelf ID of bookshelf from which to remove a volume.
* @param array $optParams Optional parameters.
*
* @opt_param string source String to identify the originator of this request.
* @return BooksEmpty
*/
public function clearVolumes($shelf, $optParams = [])
{
$params = ['shelf' => $shelf];
$params = array_merge($params, $optParams);
return $this->call('clearVolumes', [$params], BooksEmpty::class);
}
/**
* Retrieves metadata for a specific bookshelf belonging to the authenticated
* user. (bookshelves.get)
*
* @param string $shelf ID of bookshelf to retrieve.
* @param array $optParams Optional parameters.
*
* @opt_param string source String to identify the originator of this request.
* @return Bookshelf
*/
public function get($shelf, $optParams = [])
{
$params = ['shelf' => $shelf];
$params = array_merge($params, $optParams);
return $this->call('get', [$params], Bookshelf::class);
}
/**
* Retrieves a list of bookshelves belonging to the authenticated user.
* (bookshelves.listMylibraryBookshelves)
*
* @param array $optParams Optional parameters.
*
* @opt_param string source String to identify the originator of this request.
* @return Bookshelves
*/
public function listMylibraryBookshelves($optParams = [])
{
$params = [];
$params = array_merge($params, $optParams);
return $this->call('list', [$params], BookshelvesModel::class);
}
/**
* Moves a volume within a bookshelf. (bookshelves.moveVolume)
*
* @param string $shelf ID of bookshelf with the volume.
* @param string $volumeId ID of volume to move.
* @param int $volumePosition Position on shelf to move the item (0 puts the
* item before the current first item, 1 puts it between the first and the
* second and so on.)
* @param array $optParams Optional parameters.
*
* @opt_param string source String to identify the originator of this request.
* @return BooksEmpty
*/
public function moveVolume($shelf, $volumeId, $volumePosition, $optParams = [])
{
$params = ['shelf' => $shelf, 'volumeId' => $volumeId, 'volumePosition' => $volumePosition];
$params = array_merge($params, $optParams);
return $this->call('moveVolume', [$params], BooksEmpty::class);
}
/**
* Removes a volume from a bookshelf. (bookshelves.removeVolume)
*
* @param string $shelf ID of bookshelf from which to remove a volume.
* @param string $volumeId ID of volume to remove.
* @param array $optParams Optional parameters.
*
* @opt_param string reason The reason for which the book is removed from the
* library.
* @opt_param string source String to identify the originator of this request.
* @return BooksEmpty
*/
public function removeVolume($shelf, $volumeId, $optParams = [])
{
$params = ['shelf' => $shelf, 'volumeId' => $volumeId];
$params = array_merge($params, $optParams);
return $this->call('removeVolume', [$params], BooksEmpty::class);
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(MylibraryBookshelves::class, 'Google_Service_Books_Resource_MylibraryBookshelves');