Google_MylibraryBookshelvesServiceResource

The "bookshelves" collection of methods.

Defined (1)

The class is defined in the following location(s).

/src/contrib/Google_BooksService.php  
  1. class Google_MylibraryBookshelvesServiceResource extends Google_ServiceResource { 
  2.  
  3. /** 
  4. * Adds a volume to a bookshelf. (bookshelves.addVolume) 
  5. * @param string $shelf ID of bookshelf to which to add a volume. 
  6. * @param string $volumeId ID of volume to add. 
  7. * @param array $optParams Optional parameters. 
  8. * @opt_param string source String to identify the originator of this request. 
  9. */ 
  10. public function addVolume($shelf, $volumeId, $optParams = array()) { 
  11. $params = array('shelf' => $shelf, 'volumeId' => $volumeId); 
  12. $params = array_merge($params, $optParams); 
  13. $data = $this->__call('addVolume', array($params)); 
  14. return $data; 
  15. /** 
  16. * Clears all volumes from a bookshelf. (bookshelves.clearVolumes) 
  17. * @param string $shelf ID of bookshelf from which to remove a volume. 
  18. * @param array $optParams Optional parameters. 
  19. * @opt_param string source String to identify the originator of this request. 
  20. */ 
  21. public function clearVolumes($shelf, $optParams = array()) { 
  22. $params = array('shelf' => $shelf); 
  23. $params = array_merge($params, $optParams); 
  24. $data = $this->__call('clearVolumes', array($params)); 
  25. return $data; 
  26. /** 
  27. * Retrieves metadata for a specific bookshelf belonging to the authenticated user. 
  28. * (bookshelves.get) 
  29. * @param string $shelf ID of bookshelf to retrieve. 
  30. * @param array $optParams Optional parameters. 
  31. * @opt_param string source String to identify the originator of this request. 
  32. * @return Google_Bookshelf 
  33. */ 
  34. public function get($shelf, $optParams = array()) { 
  35. $params = array('shelf' => $shelf); 
  36. $params = array_merge($params, $optParams); 
  37. $data = $this->__call('get', array($params)); 
  38. if ($this->useObjects()) { 
  39. return new Google_Bookshelf($data); 
  40. } else { 
  41. return $data; 
  42. /** 
  43. * Retrieves a list of bookshelves belonging to the authenticated user. (bookshelves.list) 
  44. * @param array $optParams Optional parameters. 
  45. * @opt_param string source String to identify the originator of this request. 
  46. * @return Google_Bookshelves 
  47. */ 
  48. public function listMylibraryBookshelves($optParams = array()) { 
  49. $params = array(); 
  50. $params = array_merge($params, $optParams); 
  51. $data = $this->__call('list', array($params)); 
  52. if ($this->useObjects()) { 
  53. return new Google_Bookshelves($data); 
  54. } else { 
  55. return $data; 
  56. /** 
  57. * Moves a volume within a bookshelf. (bookshelves.moveVolume) 
  58. * @param string $shelf ID of bookshelf with the volume. 
  59. * @param string $volumeId ID of volume to move. 
  60. * @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.) 
  61. * @param array $optParams Optional parameters. 
  62. * @opt_param string source String to identify the originator of this request. 
  63. */ 
  64. public function moveVolume($shelf, $volumeId, $volumePosition, $optParams = array()) { 
  65. $params = array('shelf' => $shelf, 'volumeId' => $volumeId, 'volumePosition' => $volumePosition); 
  66. $params = array_merge($params, $optParams); 
  67. $data = $this->__call('moveVolume', array($params)); 
  68. return $data; 
  69. /** 
  70. * Removes a volume from a bookshelf. (bookshelves.removeVolume) 
  71. * @param string $shelf ID of bookshelf from which to remove a volume. 
  72. * @param string $volumeId ID of volume to remove. 
  73. * @param array $optParams Optional parameters. 
  74. * @opt_param string source String to identify the originator of this request. 
  75. */ 
  76. public function removeVolume($shelf, $volumeId, $optParams = array()) { 
  77. $params = array('shelf' => $shelf, 'volumeId' => $volumeId); 
  78. $params = array_merge($params, $optParams); 
  79. $data = $this->__call('removeVolume', array($params)); 
  80. return $data;