Documentation

Google_Service_Books_Resource_LayersVolumeAnnotations extends Google_Service_Resource
in package

The "volumeAnnotations" collection of methods.

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

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.
get()  : Google_Service_Books_Volumeannotation
Gets the volume annotation. (volumeAnnotations.get)
listLayersVolumeAnnotations()  : Google_Service_Books_Volumeannotations
Gets the volume annotations for a volume and layer.
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

get()

Gets the volume annotation. (volumeAnnotations.get)

public get(string $volumeId, string $layerId, string $annotationId[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Books_Volumeannotation
Parameters
$volumeId : string

The volume to retrieve annotations for.

$layerId : string

The ID for the layer to get the annotations.

$annotationId : string

The ID of the volume annotation to retrieve.

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

Optional parameters.

Tags
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()

Gets the volume annotations for a volume and layer.

public listLayersVolumeAnnotations(string $volumeId, string $layerId[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Books_Volumeannotations

(volumeAnnotations.listLayersVolumeAnnotations)

Parameters
$volumeId : string

The volume to retrieve annotations for.

$layerId : string

The ID for the layer to get the annotations.

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

Optional parameters.

Tags
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

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

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

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 endOffset The end offset to end retrieving data from.

opt_param

string startPosition The start position to start retrieving data from.

opt_param

string endPosition The end position to end retrieving data from.

opt_param

string source String to identify the originator of this request.

opt_param

string volumeAnnotationsVersion The version of the volume annotations that you are requesting.

opt_param

string startOffset The start offset to start retrieving data from.

opt_param

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

Return values
Google_Service_Books_Volumeannotations —

convertToArrayAndStripNulls()

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

Search results