Documentation

Google_Service_Books_Resource_MylibraryAnnotations extends Google_Service_Resource
in package

The "annotations" collection of methods.

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

Table of Contents

$client  : Google_Client
$methods  : array<string|int, mixed>
$resourceName  : string
$rootUrl  : string
$serviceName  : string
$servicePath  : string
$stackParameters  : mixed
__construct()  : mixed
call()  : Google_Http_Request|expectedClass
TODO: This function needs simplifying.
createRequestUri()  : string
Parse/expand request parameters and create a fully qualified request uri.
delete()  : Google_Service_Books_BooksEmpty
Deletes an annotation. (annotations.delete)
insert()  : Google_Service_Books_Annotation
Inserts a new annotation. (annotations.insert)
listMylibraryAnnotations()  : Google_Service_Books_Annotations
Retrieves a list of annotations, possibly filtered.
summary()  : Google_Service_Books_AnnotationsSummary
Gets the summary of specified layers. (annotations.summary)
update()  : Google_Service_Books_Annotation
Updates an existing annotation. (annotations.update)
convertToArrayAndStripNulls()  : mixed

Properties

$methods

private array<string|int, mixed> $methods

$resourceName

private string $resourceName

$serviceName

private string $serviceName

$servicePath

private string $servicePath

$stackParameters

private mixed $stackParameters = array('alt' => array('type' => 'string', 'location' => 'query'), 'fields' => array('type' => 'string', 'location' => 'query'), 'trace' => array('type' => 'string', 'location' => 'query'), 'userIp' => array('type' => 'string', 'location' => 'query'), 'quotaUser' => array('type' => 'string', 'location' => 'query'), 'data' => array('type' => 'string', 'location' => 'body'), 'mimeType' => array('type' => 'string', 'location' => 'header'), 'uploadType' => array('type' => 'string', 'location' => 'query'), 'mediaUpload' => array('type' => 'complex', 'location' => 'query'), 'prettyPrint' => array('type' => 'string', 'location' => 'query'))

Methods

__construct()

public __construct(mixed $service, mixed $serviceName, mixed $resourceName, mixed $resource) : mixed
Parameters
$service : mixed
$serviceName : mixed
$resourceName : mixed
$resource : mixed
Return values
mixed —

call()

TODO: This function needs simplifying.

public call( $name,  $arguments[,  $expectedClass = null ]) : Google_Http_Request|expectedClass
Parameters
$name :
$arguments :
$expectedClass : = null
  • optional, the expected class name
Tags
throws
Google_Exception
Return values
Google_Http_Request|expectedClass —

createRequestUri()

Parse/expand request parameters and create a fully qualified request uri.

public createRequestUri(string $restPath, array<string|int, mixed> $params) : string
Parameters
$restPath : string
$params : array<string|int, mixed>
Tags
static
Return values
string —

$requestUrl

delete()

Deletes an annotation. (annotations.delete)

public delete(string $annotationId[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Books_BooksEmpty
Parameters
$annotationId : string

The ID for the annotation to delete.

$optParams : array<string|int, mixed> = array()

Optional parameters.

Tags
opt_param

string source String to identify the originator of this request.

Return values
Google_Service_Books_BooksEmpty —

insert()

Inserts a new annotation. (annotations.insert)

public insert(Google_Service_Books_Annotation $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Books_Annotation
Parameters
$postBody : Google_Service_Books_Annotation
$optParams : array<string|int, mixed> = array()

Optional parameters.

Tags
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.

opt_param

string country ISO-3166-1 code to override the IP-based location.

opt_param

string annotationId The ID for the annotation to insert.

Return values
Google_Service_Books_Annotation —

listMylibraryAnnotations()

Retrieves a list of annotations, possibly filtered.

public listMylibraryAnnotations([array<string|int, mixed> $optParams = array() ]) : Google_Service_Books_Annotations

(annotations.listMylibraryAnnotations)

Parameters
$optParams : array<string|int, mixed> = array()

Optional parameters.

Tags
opt_param

string updatedMax RFC 3339 timestamp to restrict to items updated prior to this timestamp (exclusive).

opt_param

string layerIds The layer ID(s) to limit annotation by.

opt_param

string source String to identify the originator of this request.

opt_param

string pageToken The value of the nextToken from the previous page.

opt_param

string contentVersion The content version for the requested volume.

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 maxResults Maximum number of results to return

opt_param

string updatedMin RFC 3339 timestamp to restrict to items updated since this timestamp (inclusive).

opt_param

string volumeId The volume to restrict annotations to.

opt_param

string layerId The layer ID to limit annotation by.

Return values
Google_Service_Books_Annotations —

update()

Updates an existing annotation. (annotations.update)

public update(string $annotationId, Google_Service_Books_Annotation $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Books_Annotation
Parameters
$annotationId : string

The ID for the annotation to update.

$postBody : Google_Service_Books_Annotation
$optParams : array<string|int, mixed> = array()

Optional parameters.

Tags
opt_param

string source String to identify the originator of this request.

Return values
Google_Service_Books_Annotation —

convertToArrayAndStripNulls()

protected convertToArrayAndStripNulls(mixed $o) : mixed
Parameters
$o : mixed
Return values
mixed —

Search results