1. class
  2. Google
  3. \
  4. Service
  5. \
  6. Books
  7. \
  8. Resource
  9. \
  10. MylibraryAnnotations

MylibraryAnnotations

class MylibraryAnnotations extends Resource (View source)

The "annotations" collection of methods.

Typical usage is:

 $booksService = new Google\Service\Books(...);
 $annotations = $booksService->mylibrary_annotations;

Methods

BooksEmpty
delete(string $annotationId, array $optParams = [])

Deletes an annotation. (annotations.delete)

Annotation
insert(Annotation $postBody, array $optParams = [])

Inserts a new annotation. (annotations.insert)

Annotations
listMylibraryAnnotations(array $optParams = [])

Retrieves a list of annotations, possibly filtered.

AnnotationsSummary
summary(string|array $layerIds, string $volumeId, array $optParams = [])

Gets the summary of specified layers. (annotations.summary)

Annotation
update(string $annotationId, Annotation $postBody, array $optParams = [])

Updates an existing annotation. (annotations.update)

Details

at line 45
BooksEmpty delete(string $annotationId, array $optParams = [])

Deletes an annotation. (annotations.delete)

Parameters

string $annotationId

The ID for the annotation to delete.
array $optParams

Optional parameters.

Return Value

BooksEmpty

Exceptions

Exception

at line 65
Annotation insert(Annotation $postBody, array $optParams = [])

Inserts a new annotation. (annotations.insert)

Parameters

Annotation $postBody
array $optParams

Optional parameters.

Return Value

Annotation

Exceptions

Exception

at line 95
Annotations listMylibraryAnnotations(array $optParams = [])

Retrieves a list of annotations, possibly filtered.

(annotations.listMylibraryAnnotations)

Parameters

array $optParams

Optional parameters.

Return Value

Annotations

Exceptions

Exception

at line 113
AnnotationsSummary summary(string|array $layerIds, string $volumeId, array $optParams = [])

Gets the summary of specified layers. (annotations.summary)

Parameters

string|array $layerIds

Array of layer IDs to get the summary for.
string $volumeId

Volume id to get the summary for.
array $optParams

Optional parameters.

Return Value

AnnotationsSummary

Exceptions

Exception

at line 130
Annotation update(string $annotationId, Annotation $postBody, array $optParams = [])

Updates an existing annotation. (annotations.update)

Parameters

string $annotationId

The ID for the annotation to update.
Annotation $postBody
array $optParams

Optional parameters.

Return Value

Annotation

Exceptions

Exception