1. class
  2. Google
  3. \
  4. Service
  5. \
  6. Books
  7. \
  8. Resource
  9. \
  10. MylibraryBookshelves

MylibraryBookshelves

class MylibraryBookshelves extends Resource (View source)

The "bookshelves" collection of methods.

Typical usage is:

 $booksService = new Google\Service\Books(...);
 $bookshelves = $booksService->mylibrary_bookshelves;

Methods

BooksEmpty
addVolume(string $shelf, string $volumeId, array $optParams = [])

Adds a volume to a bookshelf. (bookshelves.addVolume)

BooksEmpty
clearVolumes(string $shelf, array $optParams = [])

Clears all volumes from a bookshelf. (bookshelves.clearVolumes)

Bookshelf
get(string $shelf, array $optParams = [])

Retrieves metadata for a specific bookshelf belonging to the authenticated user. (bookshelves.get)

Bookshelves
listMylibraryBookshelves(array $optParams = [])

Retrieves a list of bookshelves belonging to the authenticated user.

BooksEmpty
moveVolume(string $shelf, string $volumeId, int $volumePosition, array $optParams = [])

Moves a volume within a bookshelf. (bookshelves.moveVolume)

BooksEmpty
removeVolume(string $shelf, string $volumeId, array $optParams = [])

Removes a volume from a bookshelf. (bookshelves.removeVolume)

Details

at line 47
BooksEmpty addVolume(string $shelf, string $volumeId, array $optParams = [])

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.

Return Value

BooksEmpty

Exceptions

Exception

at line 63
BooksEmpty clearVolumes(string $shelf, array $optParams = [])

Clears all volumes from a bookshelf. (bookshelves.clearVolumes)

Parameters

string $shelf

ID of bookshelf from which to remove a volume.
array $optParams

Optional parameters.

Return Value

BooksEmpty

Exceptions

Exception

at line 80
Bookshelf get(string $shelf, array $optParams = [])

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.

Return Value

Bookshelf

Exceptions

Exception

at line 96
Bookshelves listMylibraryBookshelves(array $optParams = [])

Retrieves a list of bookshelves belonging to the authenticated user.

(bookshelves.listMylibraryBookshelves)

Parameters

array $optParams

Optional parameters.

Return Value

Bookshelves

Exceptions

Exception

at line 116
BooksEmpty moveVolume(string $shelf, string $volumeId, int $volumePosition, array $optParams = [])

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.

Return Value

BooksEmpty

Exceptions

Exception

at line 135
BooksEmpty removeVolume(string $shelf, string $volumeId, array $optParams = [])

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.

Return Value

BooksEmpty

Exceptions

Exception