Google_Service_Directory_Groups_Resource Class Reference

The "groups" collection of methods. More...

Inheritance diagram for Google_Service_Directory_Groups_Resource:

Public Member Functions
	call ($name, $arguments, $expected_class=null)
	TODO: This function needs simplifying.
	delete ($groupKey, $optParams=array())
	Delete Group (groups.delete)
	get ($groupKey, $optParams=array())
	Retrieve Group (groups.get)
	insert (Google_Service_Directory_Group $postBody, $optParams=array())
	Create Group (groups.insert)
	listGroups ($optParams=array())
	Retrieve all groups in a domain (paginated) (groups.listGroups)
	patch ($groupKey, Google_Service_Directory_Group $postBody, $optParams=array())
	Update Group.
	update ($groupKey, Google_Service_Directory_Group $postBody, $optParams=array())
	Update Group (groups.update)

Protected Member Functions
	convertToArrayAndStripNulls ($o)

Detailed Description

The "groups" collection of methods.

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

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

Delete Group (groups.delete)

Parameters

string	$groupKey	Email or immutable Id of the group
array	$optParams	Optional parameters.

get()

Google_Service_Directory_Groups_Resource::get	(		$groupKey,
			$optParams = array() )

Retrieve Group (groups.get)

Parameters

string	$groupKey	Email or immutable Id of the group
array	$optParams	Optional parameters.

Return values

Google_Service_Directory_Group

insert()

Google_Service_Directory_Groups_Resource::insert	(	Google_Service_Directory_Group	$postBody,
			$optParams = array() )

Create Group (groups.insert)

Parameters

Google_Group	$postBody
array	$optParams	Optional parameters.

Return values

Google_Service_Directory_Group

listGroups()

Google_Service_Directory_Groups_Resource::listGroups

(

$optParams = array()

)

Retrieve all groups in a domain (paginated) (groups.listGroups)

Parameters

array

$optParams

Optional parameters.

@opt_param string customer Immutable id of the Google Apps account. In case of multi-domain, to fetch all groups for a customer, fill this field instead of domain. @opt_param string pageToken Token to specify next page in the list @opt_param string domain Name of the domain. Fill this field to get groups from only this domain. To return all groups in a multi-domain fill customer field instead. @opt_param int maxResults Maximum number of results to return. Default is 200 @opt_param string userKey Email or immutable Id of the user if only those groups are to be listed, the given user is a member of. If Id, it should match with id of user object

Return values

Google_Service_Directory_Groups

patch()

Google_Service_Directory_Groups_Resource::patch	(		$groupKey,
		Google_Service_Directory_Group	$postBody,
			$optParams = array() )

Update Group.

This method supports patch semantics. (groups.patch)

Parameters

string	$groupKey	Email or immutable Id of the group. If Id, it should match with id of group object
Google_Group	$postBody
array	$optParams	Optional parameters.

Return values

Google_Service_Directory_Group

update()

Google_Service_Directory_Groups_Resource::update	(		$groupKey,
		Google_Service_Directory_Group	$postBody,
			$optParams = array() )

Update Group (groups.update)

Parameters

string	$groupKey	Email or immutable Id of the group. If Id, it should match with id of group object
Google_Group	$postBody
array	$optParams	Optional parameters.

Return values

Google_Service_Directory_Group

---

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

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