Google_LayersVolumeAnnotationsServiceResource

The "volumeAnnotations" collection of methods.

Defined (1)

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

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