Google_Service_Directory_Users_Resource Class Reference

The "users" collection of methods. More...

Inheritance diagram for Google_Service_Directory_Users_Resource:

Public Member Functions
	call ($name, $arguments, $expected_class=null)
	TODO: This function needs simplifying.
	delete ($userKey, $optParams=array())
	Delete user (users.delete)
	get ($userKey, $optParams=array())
	retrieve user (users.get)
	insert (Google_Service_Directory_User $postBody, $optParams=array())
	create user.
	listUsers ($optParams=array())
	Retrieve either deleted users or all users in a domain (paginated) (users.listUsers)
	makeAdmin ($userKey, Google_Service_Directory_UserMakeAdmin $postBody, $optParams=array())
	change admin status of a user (users.makeAdmin)
	patch ($userKey, Google_Service_Directory_User $postBody, $optParams=array())
	update user.
	undelete ($userKey, Google_Service_Directory_UserUndelete $postBody, $optParams=array())
	Undelete a deleted user (users.undelete)
	update ($userKey, Google_Service_Directory_User $postBody, $optParams=array())
	update user (users.update)
	watch (Google_Service_Directory_Channel $postBody, $optParams=array())
	Watch for changes in users list (users.watch)

Protected Member Functions
	convertToArrayAndStripNulls ($o)

Detailed Description

The "users" collection of methods.

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

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

Delete user (users.delete)

Parameters

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

get()

Google_Service_Directory_Users_Resource::get	(		$userKey,
			$optParams = array() )

retrieve user (users.get)

Parameters

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

@opt_param string viewType Whether to fetch the ADMIN_VIEW or DOMAIN_PUBLIC view of the user. @opt_param string customFieldMask Comma-separated list of schema names. All fields from these schemas are fetched. This should only be set when projection=custom. @opt_param string projection What subset of fields to fetch for this user.

Return values

Google_Service_Directory_User

insert()

Google_Service_Directory_Users_Resource::insert	(	Google_Service_Directory_User	$postBody,
			$optParams = array() )

create user.

(users.insert)

Parameters

Google_User	$postBody
array	$optParams	Optional parameters.

Return values

Google_Service_Directory_User

listUsers()

Google_Service_Directory_Users_Resource::listUsers

(

$optParams = array()

)

Retrieve either deleted users or all users in a domain (paginated) (users.listUsers)

Parameters

array

$optParams

Optional parameters.

@opt_param string customer Immutable id of the Google Apps account. In case of multi-domain, to fetch all users for a customer, fill this field instead of domain. @opt_param string orderBy Column to use for sorting results @opt_param string domain Name of the domain. Fill this field to get users from only this domain. To return all users in a multi-domain fill customer field instead. @opt_param string projection What subset of fields to fetch for this user. @opt_param string showDeleted If set to true retrieves the list of deleted users. Default is false @opt_param string customFieldMask Comma-separated list of schema names. All fields from these schemas are fetched. This should only be set when projection=custom. @opt_param int maxResults Maximum number of results to return. Default is

1. Max allowed is 500 @opt_param string pageToken Token to specify next page in the list @opt_param string sortOrder Whether to return results in ascending or descending order. @opt_param string query Query string search. Should be of the form "". Complete documentation is at https://developers.google.com/admin- sdk/directory/v1/guides/search-users @opt_param string viewType Whether to fetch the ADMIN_VIEW or DOMAIN_PUBLIC view of the user. @opt_param string event Event on which subscription is intended (if subscribing)

   Return values

   Google_Service_Directory_Users

makeAdmin()

Google_Service_Directory_Users_Resource::makeAdmin	(		$userKey,
		Google_Service_Directory_UserMakeAdmin	$postBody,
			$optParams = array() )

change admin status of a user (users.makeAdmin)

Parameters

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

patch()

Google_Service_Directory_Users_Resource::patch	(		$userKey,
		Google_Service_Directory_User	$postBody,
			$optParams = array() )

update user.

This method supports patch semantics. (users.patch)

Parameters

string	$userKey	Email or immutable Id of the user. If Id, it should match with id of user object
Google_User	$postBody
array	$optParams	Optional parameters.

Return values

Google_Service_Directory_User

undelete()

Google_Service_Directory_Users_Resource::undelete	(		$userKey,
		Google_Service_Directory_UserUndelete	$postBody,
			$optParams = array() )

Undelete a deleted user (users.undelete)

Parameters

string	$userKey	The immutable id of the user
Google_UserUndelete	$postBody
array	$optParams	Optional parameters.

update()

Google_Service_Directory_Users_Resource::update	(		$userKey,
		Google_Service_Directory_User	$postBody,
			$optParams = array() )

update user (users.update)

Parameters

string	$userKey	Email or immutable Id of the user. If Id, it should match with id of user object
Google_User	$postBody
array	$optParams	Optional parameters.

Return values

Google_Service_Directory_User

watch()

Google_Service_Directory_Users_Resource::watch	(	Google_Service_Directory_Channel	$postBody,
			$optParams = array() )

Watch for changes in users list (users.watch)

Parameters

Google_Channel	$postBody
array	$optParams	Optional parameters.

@opt_param string customer Immutable id of the Google Apps account. In case of multi-domain, to fetch all users for a customer, fill this field instead of domain. @opt_param string orderBy Column to use for sorting results @opt_param string domain Name of the domain. Fill this field to get users from only this domain. To return all users in a multi-domain fill customer field instead. @opt_param string projection What subset of fields to fetch for this user. @opt_param string showDeleted If set to true retrieves the list of deleted users. Default is false @opt_param string customFieldMask Comma-separated list of schema names. All fields from these schemas are fetched. This should only be set when projection=custom. @opt_param int maxResults Maximum number of results to return. Default is

1. Max allowed is 500 @opt_param string pageToken Token to specify next page in the list @opt_param string sortOrder Whether to return results in ascending or descending order. @opt_param string query Query string search. Should be of the form "". Complete documentation is at https://developers.google.com/admin- sdk/directory/v1/guides/search-users @opt_param string viewType Whether to fetch the ADMIN_VIEW or DOMAIN_PUBLIC view of the user. @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