Google_Service_Books_LayersVolumeAnnotations_Resource Class Reference

The "volumeAnnotations" collection of methods. More...

Inheritance diagram for Google_Service_Books_LayersVolumeAnnotations_Resource:

Public Member Functions
	call ($name, $arguments, $expected_class=null)
	TODO: This function needs simplifying.
	get ($volumeId, $layerId, $annotationId, $optParams=array())
	Gets the volume annotation.
	listLayersVolumeAnnotations ($volumeId, $layerId, $contentVersion, $optParams=array())
	Gets the volume annotations for a volume and layer.

Protected Member Functions
	convertToArrayAndStripNulls ($o)

Detailed Description

The "volumeAnnotations" collection of methods.

Typical usage is: $booksService = new Google_Service_Books(...); $volumeAnnotations = $booksService->volumeAnnotations;

Member Function Documentation

call()

Google_Service_Resource::call ( $name, $arguments, $expected_class = null )

inherited

TODO: This function needs simplifying.

Parameters

$name
$arguments
$expected_class	- optional, the expected class name

Return values

Google_Http_Request|expected_class

Exceptions

Google_Exception

get()

Google_Service_Books_LayersVolumeAnnotations_Resource::get	(		$volumeId,
			$layerId,
			$annotationId,
			$optParams = array() )

Gets the volume annotation.

(volumeAnnotations.get)

Parameters

string	$volumeId	The volume to retrieve annotations for.
string	$layerId	The ID for the layer to get the annotations.
string	$annotationId	The ID of the volume annotation to retrieve.
array	$optParams	Optional parameters.

@opt_param string locale The locale information for the data. ISO-639-1 language and ISO-3166-1 country code. Ex: 'en_US'. @opt_param string source String to identify the originator of this request.

Return values

Google_Service_Books_Volumeannotation

listLayersVolumeAnnotations()

Google_Service_Books_LayersVolumeAnnotations_Resource::listLayersVolumeAnnotations	(		$volumeId,
			$layerId,
			$contentVersion,
			$optParams = array() )

Gets the volume annotations for a volume and layer.

(volumeAnnotations.listLayersVolumeAnnotations)

Parameters

string	$volumeId	The volume to retrieve annotations for.
string	$layerId	The ID for the layer to get the annotations.
string	$contentVersion	The content version for the requested volume.
array	$optParams	Optional parameters.

@opt_param bool showDeleted Set to true to return deleted annotations. updatedMin must be in the request to use this. Defaults to false. @opt_param string volumeAnnotationsVersion The version of the volume annotations that you are requesting. @opt_param string endPosition The end position to end retrieving data from. @opt_param string endOffset The end offset to end retrieving data from. @opt_param string locale The locale information for the data. ISO-639-1 language and ISO-3166-1 country code. Ex: 'en_US'. @opt_param string updatedMin RFC 3339 timestamp to restrict to items updated since this timestamp (inclusive). @opt_param string updatedMax RFC 3339 timestamp to restrict to items updated prior to this timestamp (exclusive). @opt_param string maxResults Maximum number of results to return @opt_param string pageToken The value of the nextToken from the previous page. @opt_param string source String to identify the originator of this request. @opt_param string startOffset The start offset to start retrieving data from. @opt_param string startPosition The start position to start retrieving data from.

Return values

Google_Service_Books_Volumeannotations

---

The documentation for this class was generated from the following file:

• lib/google/src/Google/Service/Books.php