Google_Service_Directory_UsersAliases_Resource Class Reference

The "aliases" collection of methods. More...

Inheritance diagram for Google_Service_Directory_UsersAliases_Resource:

Public Member Functions
	call ($name, $arguments, $expected_class=null)
	TODO: This function needs simplifying.
	delete ($userKey, $alias, $optParams=array())
	Remove a alias for the user (aliases.delete)
	insert ($userKey, Google_Service_Directory_Alias $postBody, $optParams=array())
	Add a alias for the user (aliases.insert)
	listUsersAliases ($userKey, $optParams=array())
	List all aliases for a user (aliases.listUsersAliases)
	watch ($userKey, Google_Service_Directory_Channel $postBody, $optParams=array())
	Watch for changes in user aliases list (aliases.watch)

Protected Member Functions
	convertToArrayAndStripNulls ($o)

Detailed Description

The "aliases" collection of methods.

Typical usage is: $adminService = new Google_Service_Directory(...); $aliases = $adminService->aliases;

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_Directory_UsersAliases_Resource::delete	(		$userKey,
			$alias,
			$optParams = array() )

Remove a alias for the user (aliases.delete)

Parameters

string	$userKey	Email or immutable Id of the user
string	$alias	The alias to be removed
array	$optParams	Optional parameters.

insert()

Google_Service_Directory_UsersAliases_Resource::insert	(		$userKey,
		Google_Service_Directory_Alias	$postBody,
			$optParams = array() )

Add a alias for the user (aliases.insert)

Parameters

string	$userKey	Email or immutable Id of the user
Google_Alias	$postBody
array	$optParams	Optional parameters.

Return values

Google_Service_Directory_Alias

listUsersAliases()

Google_Service_Directory_UsersAliases_Resource::listUsersAliases	(		$userKey,
			$optParams = array() )

List all aliases for a user (aliases.listUsersAliases)

Parameters

string	$userKey	Email or immutable Id of the user
array	$optParams	Optional parameters.

@opt_param string event Event on which subscription is intended (if subscribing)

Return values

Google_Service_Directory_Aliases

watch()

Google_Service_Directory_UsersAliases_Resource::watch	(		$userKey,
		Google_Service_Directory_Channel	$postBody,
			$optParams = array() )

Watch for changes in user aliases list (aliases.watch)

Parameters

string	$userKey	Email or immutable Id of the user
Google_Channel	$postBody
array	$optParams	Optional parameters.

@opt_param string event Event on which subscription is intended (if subscribing)

Return values

Google_Service_Directory_Channel

---

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

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