Google_Service_Drive_Properties_Resource Class Reference

The "properties" collection of methods. More...

Inheritance diagram for Google_Service_Drive_Properties_Resource:

Public Member Functions
	call ($name, $arguments, $expected_class=null)
	TODO: This function needs simplifying.
	delete ($fileId, $propertyKey, $optParams=array())
	Deletes a property.
	get ($fileId, $propertyKey, $optParams=array())
	Gets a property by its key.
	insert ($fileId, Google_Service_Drive_Property $postBody, $optParams=array())
	Adds a property to a file.
	listProperties ($fileId, $optParams=array())
	Lists a file's properties.
	patch ($fileId, $propertyKey, Google_Service_Drive_Property $postBody, $optParams=array())
	Updates a property.
	update ($fileId, $propertyKey, Google_Service_Drive_Property $postBody, $optParams=array())
	Updates a property.

Protected Member Functions
	convertToArrayAndStripNulls ($o)

Detailed Description

The "properties" collection of methods.

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

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_Properties_Resource::delete	(		$fileId,
			$propertyKey,
			$optParams = array() )

Deletes a property.

(properties.delete)

Parameters

string	$fileId	The ID of the file.
string	$propertyKey	The key of the property.
array	$optParams	Optional parameters.

@opt_param string visibility The visibility of the property.

get()

Google_Service_Drive_Properties_Resource::get	(		$fileId,
			$propertyKey,
			$optParams = array() )

Gets a property by its key.

(properties.get)

Parameters

string	$fileId	The ID of the file.
string	$propertyKey	The key of the property.
array	$optParams	Optional parameters.

@opt_param string visibility The visibility of the property.

Return values

Google_Service_Drive_Property

insert()

Google_Service_Drive_Properties_Resource::insert	(		$fileId,
		Google_Service_Drive_Property	$postBody,
			$optParams = array() )

Adds a property to a file.

(properties.insert)

Parameters

string	$fileId	The ID of the file.
Google_Property	$postBody
array	$optParams	Optional parameters.

Return values

Google_Service_Drive_Property

listProperties()

Google_Service_Drive_Properties_Resource::listProperties	(		$fileId,
			$optParams = array() )

Lists a file's properties.

(properties.listProperties)

Parameters

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

Return values

Google_Service_Drive_PropertyList

patch()

Google_Service_Drive_Properties_Resource::patch	(		$fileId,
			$propertyKey,
		Google_Service_Drive_Property	$postBody,
			$optParams = array() )

Updates a property.

This method supports patch semantics. (properties.patch)

Parameters

string	$fileId	The ID of the file.
string	$propertyKey	The key of the property.
Google_Property	$postBody
array	$optParams	Optional parameters.

@opt_param string visibility The visibility of the property.

Return values

Google_Service_Drive_Property

update()

Google_Service_Drive_Properties_Resource::update	(		$fileId,
			$propertyKey,
		Google_Service_Drive_Property	$postBody,
			$optParams = array() )

Updates a property.

(properties.update)

Parameters

string	$fileId	The ID of the file.
string	$propertyKey	The key of the property.
Google_Property	$postBody
array	$optParams	Optional parameters.

@opt_param string visibility The visibility of the property.

Return values

Google_Service_Drive_Property

---

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

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