Google_LayersAnnotationDataServiceResource

The "annotationData" 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_LayersAnnotationDataServiceResource extends Google_ServiceResource { 
  2.  
  3.  
  4. /** 
  5. * Gets the annotation data for a volume and layer. (annotationData.list) 
  6. * @param string $volumeId The volume to retrieve annotation data for. 
  7. * @param string $layerId The ID for the layer to get the annotation data. 
  8. * @param string $contentVersion The content version for the requested volume. 
  9. * @param array $optParams Optional parameters. 
  10. * @opt_param int scale The requested scale for the image. 
  11. * @opt_param string source String to identify the originator of this request. 
  12. * @opt_param string locale The locale information for the data. ISO-639-1 language and ISO-3166-1 country code. Ex: 'en_US'. 
  13. * @opt_param int h The requested pixel height for any images. If height is provided width must also be provided. 
  14. * @opt_param string updatedMax RFC 3339 timestamp to restrict to items updated prior to this timestamp (exclusive). 
  15. * @opt_param string maxResults Maximum number of results to return 
  16. * @opt_param string annotationDataId The list of Annotation Data Ids to retrieve. Pagination is ignored if this is set. 
  17. * @opt_param string pageToken The value of the nextToken from the previous page. 
  18. * @opt_param int w The requested pixel width for any images. If width is provided height must also be provided. 
  19. * @opt_param string updatedMin RFC 3339 timestamp to restrict to items updated since this timestamp (inclusive). 
  20. * @return Google_Annotationsdata 
  21. */ 
  22. public function listLayersAnnotationData($volumeId, $layerId, $contentVersion, $optParams = array()) { 
  23. $params = array('volumeId' => $volumeId, 'layerId' => $layerId, 'contentVersion' => $contentVersion); 
  24. $params = array_merge($params, $optParams); 
  25. $data = $this->__call('list', array($params)); 
  26. if ($this->useObjects()) { 
  27. return new Google_Annotationsdata($data); 
  28. } else { 
  29. return $data; 
  30. /** 
  31. * Gets the annotation data. (annotationData.get) 
  32. * @param string $volumeId The volume to retrieve annotations for. 
  33. * @param string $layerId The ID for the layer to get the annotations. 
  34. * @param string $annotationDataId The ID of the annotation data to retrieve. 
  35. * @param string $contentVersion The content version for the volume you are trying to retrieve. 
  36. * @param array $optParams Optional parameters. 
  37. * @opt_param int scale The requested scale for the image. 
  38. * @opt_param string locale The locale information for the data. ISO-639-1 language and ISO-3166-1 country code. Ex: 'en_US'. 
  39. * @opt_param int h The requested pixel height for any images. If height is provided width must also be provided. 
  40. * @opt_param string source String to identify the originator of this request. 
  41. * @opt_param int w The requested pixel width for any images. If width is provided height must also be provided. 
  42. * @return Google_Annotationdata 
  43. */ 
  44. public function get($volumeId, $layerId, $annotationDataId, $contentVersion, $optParams = array()) { 
  45. $params = array('volumeId' => $volumeId, 'layerId' => $layerId, 'annotationDataId' => $annotationDataId, 'contentVersion' => $contentVersion); 
  46. $params = array_merge($params, $optParams); 
  47. $data = $this->__call('get', array($params)); 
  48. if ($this->useObjects()) { 
  49. return new Google_Annotationdata($data); 
  50. } else { 
  51. return $data;