Google_Service_Books_LayersAnnotationData_Resource Class Reference

The "annotationData" collection of methods. More...

Inheritance diagram for Google_Service_Books_LayersAnnotationData_Resource:

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

Protected Member Functions
	convertToArrayAndStripNulls ($o)

Detailed Description

The "annotationData" collection of methods.

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

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_LayersAnnotationData_Resource::get	(		$volumeId,
			$layerId,
			$annotationDataId,
			$contentVersion,
			$optParams = array() )

Gets the annotation data.

(annotationData.get)

Parameters

string	$volumeId	The volume to retrieve annotations for.
string	$layerId	The ID for the layer to get the annotations.
string	$annotationDataId	The ID of the annotation data to retrieve.
string	$contentVersion	The content version for the volume you are trying to retrieve.
array	$optParams	Optional parameters.

@opt_param int scale The requested scale for the image. @opt_param string source String to identify the originator of this request. @opt_param bool allowWebDefinitions For the dictionary layer. Whether or not to allow web definitions. @opt_param int h The requested pixel height for any images. If height is provided width must also be provided. @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 int w The requested pixel width for any images. If width is provided height must also be provided.

Return values

Google_Service_Books_Annotationdata

listLayersAnnotationData()

Google_Service_Books_LayersAnnotationData_Resource::listLayersAnnotationData	(		$volumeId,
			$layerId,
			$contentVersion,
			$optParams = array() )

Gets the annotation data for a volume and layer.

(annotationData.listLayersAnnotationData)

Parameters

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

@opt_param int scale The requested scale for the image. @opt_param string source String to identify the originator of this request. @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 int h The requested pixel height for any images. If height is provided width must also be provided. @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 annotationDataId The list of Annotation Data Ids to retrieve. Pagination is ignored if this is set. @opt_param string pageToken The value of the nextToken from the previous page. @opt_param int w The requested pixel width for any images. If width is provided height must also be provided. @opt_param string updatedMin RFC 3339 timestamp to restrict to items updated since this timestamp (inclusive).

Return values

Google_Service_Books_Annotationsdata

---

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

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