Google_Service_Books_MylibraryAnnotations_Resource Class Reference

The "annotations" collection of methods. More...

Inheritance diagram for Google_Service_Books_MylibraryAnnotations_Resource:

Public Member Functions
	call ($name, $arguments, $expected_class=null)
	TODO: This function needs simplifying.
	delete ($annotationId, $optParams=array())
	Deletes an annotation.
	insert (Google_Service_Books_Annotation $postBody, $optParams=array())
	Inserts a new annotation.
	listMylibraryAnnotations ($optParams=array())
	Retrieves a list of annotations, possibly filtered.
	summary ($layerIds, $volumeId, $optParams=array())
	Gets the summary of specified layers.
	update ($annotationId, Google_Service_Books_Annotation $postBody, $optParams=array())
	Updates an existing annotation.

Protected Member Functions
	convertToArrayAndStripNulls ($o)

Detailed Description

The "annotations" collection of methods.

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

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

delete()

Google_Service_Books_MylibraryAnnotations_Resource::delete	(		$annotationId,
			$optParams = array() )

Deletes an annotation.

(annotations.delete)

Parameters

string	$annotationId	The ID for the annotation to delete.
array	$optParams	Optional parameters.

@opt_param string source String to identify the originator of this request.

insert()

Google_Service_Books_MylibraryAnnotations_Resource::insert	(	Google_Service_Books_Annotation	$postBody,
			$optParams = array() )

Inserts a new annotation.

(annotations.insert)

Parameters

Google_Annotation	$postBody
array	$optParams	Optional parameters.

@opt_param string country ISO-3166-1 code to override the IP-based location. @opt_param bool showOnlySummaryInResponse Requests that only the summary of the specified layer be provided in the response. @opt_param string source String to identify the originator of this request.

Return values

Google_Service_Books_Annotation

listMylibraryAnnotations()

Google_Service_Books_MylibraryAnnotations_Resource::listMylibraryAnnotations

(

$optParams = array()

)

Retrieves a list of annotations, possibly filtered.

(annotations.listMylibraryAnnotations)

Parameters

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 updatedMin RFC 3339 timestamp to restrict to items updated since this timestamp (inclusive). @opt_param string layerIds The layer ID(s) to limit annotation by. @opt_param string volumeId The volume to restrict annotations to. @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 updatedMax RFC 3339 timestamp to restrict to items updated prior to this timestamp (exclusive). @opt_param string contentVersion The content version for the requested volume. @opt_param string source String to identify the originator of this request. @opt_param string layerId The layer ID to limit annotation by.

Return values

Google_Service_Books_Annotations

summary()

Google_Service_Books_MylibraryAnnotations_Resource::summary	(		$layerIds,
			$volumeId,
			$optParams = array() )

Gets the summary of specified layers.

(annotations.summary)

Parameters

string	$layerIds	Array of layer IDs to get the summary for.
string	$volumeId	Volume id to get the summary for.
array	$optParams	Optional parameters.

Return values

Google_Service_Books_AnnotationsSummary

update()

Google_Service_Books_MylibraryAnnotations_Resource::update	(		$annotationId,
		Google_Service_Books_Annotation	$postBody,
			$optParams = array() )

Updates an existing annotation.

(annotations.update)

Parameters

string	$annotationId	The ID for the annotation to update.
Google_Annotation	$postBody
array	$optParams	Optional parameters.

@opt_param string source String to identify the originator of this request.

Return values

Google_Service_Books_Annotation

---

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

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