class Notes extends Resource (View source)

The "notes" collection of methods.

Typical usage is:

 $keepService = new Google\Service\Keep(...);
 $notes = $keepService->notes;

Methods

create(Note $postBody, array $optParams = [])

Creates a new note. (notes.create)

delete(string $name, array $optParams = [])

Deletes a note. Caller must have the OWNER role on the note to delete.

get(string $name, array $optParams = [])

Gets a note. (notes.get)

listNotes(array $optParams = [])

Lists notes. Every list call returns a page of results with page_size as the upper bound of returned items. A page_size of zero allows the server to choose the upper bound. The ListNotesResponse contains at most page_size entries. If there are more things left to list, it provides a next_page_token value. (Page tokens are opaque values.) To get the next page of results, copy the result's next_page_token into the next request's page_token. Repeat until the next_page_token returned with a page of results is empty. ListNotes return consistent results in the face of concurrent changes, or signals that it cannot with an ABORTED error.

Details

Note create(Note $postBody, array $optParams = [])

Creates a new note. (notes.create)

Parameters

Note $postBody
array $optParams

Optional parameters.

Return Value

Note

Exceptions

Exception

KeepEmpty delete(string $name, array $optParams = [])

Deletes a note. Caller must have the OWNER role on the note to delete.

Deleting a note removes the resource immediately and cannot be undone. Any collaborators will lose access to the note. (notes.delete)

Parameters

string $name

Required. Name of the note to delete.

array $optParams

Optional parameters.

Return Value

KeepEmpty

Exceptions

Exception

Note get(string $name, array $optParams = [])

Gets a note. (notes.get)

Parameters

string $name

Required. Name of the resource.

array $optParams

Optional parameters.

Return Value

Note

Exceptions

Exception

ListNotesResponse listNotes(array $optParams = [])

Lists notes. Every list call returns a page of results with page_size as the upper bound of returned items. A page_size of zero allows the server to choose the upper bound. The ListNotesResponse contains at most page_size entries. If there are more things left to list, it provides a next_page_token value. (Page tokens are opaque values.) To get the next page of results, copy the result's next_page_token into the next request's page_token. Repeat until the next_page_token returned with a page of results is empty. ListNotes return consistent results in the face of concurrent changes, or signals that it cannot with an ABORTED error.

(notes.listNotes)

Parameters

array $optParams

Optional parameters.

Return Value

ListNotesResponse

Exceptions

Exception