class NotesPermissions extends Resource (View source)

The "permissions" collection of methods.

Typical usage is:

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

Methods

batchCreate(string $parent, BatchCreatePermissionsRequest $postBody, array $optParams = [])

Creates one or more permissions on the note. Only permissions with the WRITER role may be created. If adding any permission fails, then the entire request fails and no changes are made. (permissions.batchCreate)

batchDelete(string $parent, BatchDeletePermissionsRequest $postBody, array $optParams = [])

Deletes one or more permissions on the note. The specified entities will immediately lose access. A permission with the OWNER role can't be removed.

Details

BatchCreatePermissionsResponse batchCreate(string $parent, BatchCreatePermissionsRequest $postBody, array $optParams = [])

Creates one or more permissions on the note. Only permissions with the WRITER role may be created. If adding any permission fails, then the entire request fails and no changes are made. (permissions.batchCreate)

Parameters

string $parent

The parent resource shared by all Permissions being created. Format: notes/{note} If this is set, the parent field in the CreatePermission messages must either be empty or match this field.

BatchCreatePermissionsRequest $postBody
array $optParams

Optional parameters.

Return Value

BatchCreatePermissionsResponse

Exceptions

Exception

KeepEmpty batchDelete(string $parent, BatchDeletePermissionsRequest $postBody, array $optParams = [])

Deletes one or more permissions on the note. The specified entities will immediately lose access. A permission with the OWNER role can't be removed.

If removing a permission fails, then the entire request fails and no changes are made. Returns a 400 bad request error if a specified permission does not exist on the note. (permissions.batchDelete)

Parameters

string $parent

The parent resource shared by all permissions being deleted. Format: notes/{note} If this is set, the parent of all of the permissions specified in the DeletePermissionRequest messages must match this field.

BatchDeletePermissionsRequest $postBody
array $optParams

Optional parameters.

Return Value

KeepEmpty

Exceptions

Exception