Google_Service_Books_LayersVolumeAnnotations_Resource

The "volumeAnnotations" collection of methods.

Defined (1)

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

/includes/api-libs/Google/Service/Books.php  
  1. class Google_Service_Books_LayersVolumeAnnotations_Resource extends Google_Service_Resource 
  2.  
  3. /** 
  4. * Gets the volume annotation. (volumeAnnotations.get) 
  5. * @param string $volumeId The volume to retrieve annotations for. 
  6. * @param string $layerId The ID for the layer to get the annotations. 
  7. * @param string $annotationId The ID of the volume annotation to retrieve. 
  8. * @param array $optParams Optional parameters. 
  9. * @opt_param string locale The locale information for the data. ISO-639-1 
  10. * language and ISO-3166-1 country code. Ex: 'en_US'. 
  11. * @opt_param string source String to identify the originator of this request. 
  12. * @return Google_Service_Books_Volumeannotation 
  13. */ 
  14. public function get($volumeId, $layerId, $annotationId, $optParams = array()) 
  15. $params = array('volumeId' => $volumeId, 'layerId' => $layerId, 'annotationId' => $annotationId); 
  16. $params = array_merge($params, $optParams); 
  17. return $this->call('get', array($params), "Google_Service_Books_Volumeannotation"); 
  18.  
  19. /** 
  20. * Gets the volume annotations for a volume and layer. 
  21. * (volumeAnnotations.listLayersVolumeAnnotations) 
  22. * @param string $volumeId The volume to retrieve annotations for. 
  23. * @param string $layerId The ID for the layer to get the annotations. 
  24. * @param string $contentVersion The content version for the requested volume. 
  25. * @param array $optParams Optional parameters. 
  26. * @opt_param bool showDeleted Set to true to return deleted annotations. 
  27. * updatedMin must be in the request to use this. Defaults to false. 
  28. * @opt_param string volumeAnnotationsVersion The version of the volume 
  29. * annotations that you are requesting. 
  30. * @opt_param string endPosition The end position to end retrieving data from. 
  31. * @opt_param string endOffset The end offset to end retrieving data from. 
  32. * @opt_param string locale The locale information for the data. ISO-639-1 
  33. * language and ISO-3166-1 country code. Ex: 'en_US'. 
  34. * @opt_param string updatedMin RFC 3339 timestamp to restrict to items updated 
  35. * since this timestamp (inclusive). 
  36. * @opt_param string updatedMax RFC 3339 timestamp to restrict to items updated 
  37. * prior to this timestamp (exclusive). 
  38. * @opt_param string maxResults Maximum number of results to return 
  39. * @opt_param string pageToken The value of the nextToken from the previous 
  40. * page. 
  41. * @opt_param string source String to identify the originator of this request. 
  42. * @opt_param string startOffset The start offset to start retrieving data from. 
  43. * @opt_param string startPosition The start position to start retrieving data 
  44. * from. 
  45. * @return Google_Service_Books_Volumeannotations 
  46. */ 
  47. public function listLayersVolumeAnnotations($volumeId, $layerId, $contentVersion, $optParams = array()) 
  48. $params = array('volumeId' => $volumeId, 'layerId' => $layerId, 'contentVersion' => $contentVersion); 
  49. $params = array_merge($params, $optParams); 
  50. return $this->call('list', array($params), "Google_Service_Books_Volumeannotations");