Google_Service_Drive_Permissions_Resource Class Reference

The "permissions" collection of methods. More...

Inheritance diagram for Google_Service_Drive_Permissions_Resource:

Public Member Functions
	call ($name, $arguments, $expected_class=null)
	TODO: This function needs simplifying.
	delete ($fileId, $permissionId, $optParams=array())
	Deletes a permission from a file.
	get ($fileId, $permissionId, $optParams=array())
	Gets a permission by ID.
	getIdForEmail ($email, $optParams=array())
	Returns the permission ID for an email address.
	insert ($fileId, Google_Service_Drive_Permission $postBody, $optParams=array())
	Inserts a permission for a file.
	listPermissions ($fileId, $optParams=array())
	Lists a file's permissions.
	patch ($fileId, $permissionId, Google_Service_Drive_Permission $postBody, $optParams=array())
	Updates a permission using patch semantics.
	update ($fileId, $permissionId, Google_Service_Drive_Permission $postBody, $optParams=array())
	Updates a permission.

Protected Member Functions
	convertToArrayAndStripNulls ($o)

Detailed Description

The "permissions" collection of methods.

Typical usage is: $driveService = new Google_Service_Drive(...); $permissions = $driveService->permissions;

Member Function Documentation

call()

Google_Service_Resource::call ( $name, $arguments, $expected_class = null )

inherited

TODO: This function needs simplifying.

Parameters

$name
$arguments
$expected_class	- optional, the expected class name

Return values

Google_Http_Request|expected_class

Exceptions

Google_Exception

delete()

Google_Service_Drive_Permissions_Resource::delete	(		$fileId,
			$permissionId,
			$optParams = array() )

Deletes a permission from a file.

(permissions.delete)

Parameters

string	$fileId	The ID for the file.
string	$permissionId	The ID for the permission.
array	$optParams	Optional parameters.

get()

Google_Service_Drive_Permissions_Resource::get	(		$fileId,
			$permissionId,
			$optParams = array() )

Gets a permission by ID.

(permissions.get)

Parameters

string	$fileId	The ID for the file.
string	$permissionId	The ID for the permission.
array	$optParams	Optional parameters.

Return values

Google_Service_Drive_Permission

getIdForEmail()

Google_Service_Drive_Permissions_Resource::getIdForEmail	(		$email,
			$optParams = array() )

Returns the permission ID for an email address.

(permissions.getIdForEmail)

Parameters

string	$email	The email address for which to return a permission ID
array	$optParams	Optional parameters.

Return values

Google_Service_Drive_PermissionId

insert()

Google_Service_Drive_Permissions_Resource::insert	(		$fileId,
		Google_Service_Drive_Permission	$postBody,
			$optParams = array() )

Inserts a permission for a file.

(permissions.insert)

Parameters

string	$fileId	The ID for the file.
Google_Permission	$postBody
array	$optParams	Optional parameters.

@opt_param string emailMessage A custom message to include in notification emails. @opt_param bool sendNotificationEmails Whether to send notification emails when sharing to users or groups. This parameter is ignored and an email is sent if the role is owner.

Return values

Google_Service_Drive_Permission

listPermissions()

Google_Service_Drive_Permissions_Resource::listPermissions	(		$fileId,
			$optParams = array() )

Lists a file's permissions.

(permissions.listPermissions)

Parameters

string	$fileId	The ID for the file.
array	$optParams	Optional parameters.

Return values

Google_Service_Drive_PermissionList

patch()

Google_Service_Drive_Permissions_Resource::patch	(		$fileId,
			$permissionId,
		Google_Service_Drive_Permission	$postBody,
			$optParams = array() )

Updates a permission using patch semantics.

(permissions.patch)

Parameters

string	$fileId	The ID for the file.
string	$permissionId	The ID for the permission.
Google_Permission	$postBody
array	$optParams	Optional parameters.

@opt_param bool transferOwnership Whether changing a role to 'owner' downgrades the current owners to writers. Does nothing if the specified role is not 'owner'.

Return values

Google_Service_Drive_Permission

update()

Google_Service_Drive_Permissions_Resource::update	(		$fileId,
			$permissionId,
		Google_Service_Drive_Permission	$postBody,
			$optParams = array() )

Updates a permission.

(permissions.update)

Parameters

string	$fileId	The ID for the file.
string	$permissionId	The ID for the permission.
Google_Permission	$postBody
array	$optParams	Optional parameters.

@opt_param bool transferOwnership Whether changing a role to 'owner' downgrades the current owners to writers. Does nothing if the specified role is not 'owner'.

Return values

Google_Service_Drive_Permission

---

The documentation for this class was generated from the following file:

• lib/google/src/Google/Service/Drive.php