Google_MylibraryAnnotationsServiceResource

The "annotations" collection of methods.

Defined (1)

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

/src/contrib/Google_BooksService.php  
  1. class Google_MylibraryAnnotationsServiceResource extends Google_ServiceResource { 
  2.  
  3. /** 
  4. * Deletes an annotation. (annotations.delete) 
  5. * @param string $annotationId The ID for the annotation to delete. 
  6. * @param array $optParams Optional parameters. 
  7. * @opt_param string source String to identify the originator of this request. 
  8. */ 
  9. public function delete($annotationId, $optParams = array()) { 
  10. $params = array('annotationId' => $annotationId); 
  11. $params = array_merge($params, $optParams); 
  12. $data = $this->__call('delete', array($params)); 
  13. return $data; 
  14. /** 
  15. * Gets an annotation by its ID. (annotations.get) 
  16. * @param string $annotationId The ID for the annotation to retrieve. 
  17. * @param array $optParams Optional parameters. 
  18. * @opt_param string source String to identify the originator of this request. 
  19. * @return Google_Annotation 
  20. */ 
  21. public function get($annotationId, $optParams = array()) { 
  22. $params = array('annotationId' => $annotationId); 
  23. $params = array_merge($params, $optParams); 
  24. $data = $this->__call('get', array($params)); 
  25. if ($this->useObjects()) { 
  26. return new Google_Annotation($data); 
  27. } else { 
  28. return $data; 
  29. /** 
  30. * Inserts a new annotation. (annotations.insert) 
  31. * @param Google_Annotation $postBody 
  32. * @param array $optParams Optional parameters. 
  33. * @opt_param string source String to identify the originator of this request. 
  34. * @return Google_Annotation 
  35. */ 
  36. public function insert(Google_Annotation $postBody, $optParams = array()) { 
  37. $params = array('postBody' => $postBody); 
  38. $params = array_merge($params, $optParams); 
  39. $data = $this->__call('insert', array($params)); 
  40. if ($this->useObjects()) { 
  41. return new Google_Annotation($data); 
  42. } else { 
  43. return $data; 
  44. /** 
  45. * Retrieves a list of annotations, possibly filtered. (annotations.list) 
  46. * @param array $optParams Optional parameters. 
  47. * @opt_param string contentVersion The content version for the requested volume. 
  48. * @opt_param string layerId The layer ID to limit annotation by. 
  49. * @opt_param string maxResults Maximum number of results to return 
  50. * @opt_param string pageIds The page ID(s) for the volume that is being queried. 
  51. * @opt_param string pageToken The value of the nextToken from the previous page. 
  52. * @opt_param bool showDeleted Set to true to return deleted annotations. updatedMin must be in the request to use this. Defaults to false. 
  53. * @opt_param string source String to identify the originator of this request. 
  54. * @opt_param string updatedMax RFC 3339 timestamp to restrict to items updated prior to this timestamp (exclusive). 
  55. * @opt_param string updatedMin RFC 3339 timestamp to restrict to items updated since this timestamp (inclusive). 
  56. * @opt_param string volumeId The volume to restrict annotations to. 
  57. * @return Google_Annotations 
  58. */ 
  59. public function listMylibraryAnnotations($optParams = array()) { 
  60. $params = array(); 
  61. $params = array_merge($params, $optParams); 
  62. $data = $this->__call('list', array($params)); 
  63. if ($this->useObjects()) { 
  64. return new Google_Annotations($data); 
  65. } else { 
  66. return $data; 
  67. /** 
  68. * Updates an existing annotation. (annotations.update) 
  69. * @param string $annotationId The ID for the annotation to update. 
  70. * @param Google_Annotation $postBody 
  71. * @param array $optParams Optional parameters. 
  72. * @opt_param string source String to identify the originator of this request. 
  73. * @return Google_Annotation 
  74. */ 
  75. public function update($annotationId, Google_Annotation $postBody, $optParams = array()) { 
  76. $params = array('annotationId' => $annotationId, 'postBody' => $postBody); 
  77. $params = array_merge($params, $optParams); 
  78. $data = $this->__call('update', array($params)); 
  79. if ($this->useObjects()) { 
  80. return new Google_Annotation($data); 
  81. } else { 
  82. return $data;