Google_Service_Books_MylibraryBookshelves_Resource Class Reference

The "bookshelves" collection of methods. More...

Inheritance diagram for Google_Service_Books_MylibraryBookshelves_Resource:

Public Member Functions
	addVolume ($shelf, $volumeId, $optParams=array())
	Adds a volume to a bookshelf.
	call ($name, $arguments, $expected_class=null)
	TODO: This function needs simplifying.
	clearVolumes ($shelf, $optParams=array())
	Clears all volumes from a bookshelf.
	get ($shelf, $optParams=array())
	Retrieves metadata for a specific bookshelf belonging to the authenticated user.
	listMylibraryBookshelves ($optParams=array())
	Retrieves a list of bookshelves belonging to the authenticated user.
	moveVolume ($shelf, $volumeId, $volumePosition, $optParams=array())
	Moves a volume within a bookshelf.
	removeVolume ($shelf, $volumeId, $optParams=array())
	Removes a volume from a bookshelf.

Protected Member Functions
	convertToArrayAndStripNulls ($o)

Detailed Description

The "bookshelves" collection of methods.

Typical usage is: $booksService = new Google_Service_Books(...); $bookshelves = $booksService->bookshelves;

Member Function Documentation

addVolume()

Google_Service_Books_MylibraryBookshelves_Resource::addVolume	(		$shelf,
			$volumeId,
			$optParams = array() )

Adds a volume to a bookshelf.

(bookshelves.addVolume)

Parameters

string	$shelf	ID of bookshelf to which to add a volume.
string	$volumeId	ID of volume to add.
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.

call()

Google_Service_Resource::call ( $name, $arguments, $expected_class = null )

inherited

TODO: This function needs simplifying.

Parameters

$name
$arguments
$expected_class	- optional, the expected class name

Return values

Google_Http_Request|expected_class

Exceptions

Google_Exception

clearVolumes()

Google_Service_Books_MylibraryBookshelves_Resource::clearVolumes	(		$shelf,
			$optParams = array() )

Clears all volumes from a bookshelf.

(bookshelves.clearVolumes)

Parameters

string	$shelf	ID of bookshelf from which to remove a volume.
array	$optParams	Optional parameters.

@opt_param string source String to identify the originator of this request.

get()

Google_Service_Books_MylibraryBookshelves_Resource::get	(		$shelf,
			$optParams = array() )

Retrieves metadata for a specific bookshelf belonging to the authenticated user.

(bookshelves.get)

Parameters

string	$shelf	ID of bookshelf to retrieve.
array	$optParams	Optional parameters.

@opt_param string source String to identify the originator of this request.

Return values

Google_Service_Books_Bookshelf

listMylibraryBookshelves()

Google_Service_Books_MylibraryBookshelves_Resource::listMylibraryBookshelves

(

$optParams = array()

)

Retrieves a list of bookshelves belonging to the authenticated user.

(bookshelves.listMylibraryBookshelves)

Parameters

array

$optParams

Optional parameters.

@opt_param string source String to identify the originator of this request.

Return values

Google_Service_Books_Bookshelves

moveVolume()

Google_Service_Books_MylibraryBookshelves_Resource::moveVolume	(		$shelf,
			$volumeId,
			$volumePosition,
			$optParams = array() )

Moves a volume within a bookshelf.

(bookshelves.moveVolume)

Parameters

string	$shelf	ID of bookshelf with the volume.
string	$volumeId	ID of volume to move.
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.)
array	$optParams	Optional parameters.

@opt_param string source String to identify the originator of this request.

removeVolume()

Google_Service_Books_MylibraryBookshelves_Resource::removeVolume	(		$shelf,
			$volumeId,
			$optParams = array() )

Removes a volume from a bookshelf.

(bookshelves.removeVolume)

Parameters

string	$shelf	ID of bookshelf from which to remove a volume.
string	$volumeId	ID of volume to remove.
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.

---

The documentation for this class was generated from the following file:

• lib/google/src/Google/Service/Books.php