Documentation

Google_Service_Directory_Resource_Groups extends Google_Service_Resource
in package

The "groups" collection of methods.

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

Table of Contents

$client  : Google_Client
$methods  : array<string|int, mixed>
$resourceName  : string
$rootUrl  : string
$serviceName  : string
$servicePath  : string
$stackParameters  : mixed
__construct()  : mixed
call()  : Google_Http_Request|expectedClass
TODO: This function needs simplifying.
createRequestUri()  : string
Parse/expand request parameters and create a fully qualified request uri.
delete()  : mixed
Delete Group (groups.delete)
get()  : Google_Service_Directory_Group
Retrieve Group (groups.get)
insert()  : Google_Service_Directory_Group
Create Group (groups.insert)
listGroups()  : Google_Service_Directory_Groups
Retrieve all groups of a domain or of a user given a userKey (paginated) (groups.listGroups)
patch()  : Google_Service_Directory_Group
Patch Groups via Apiary Patch Orchestration (groups.patch)
update()  : Google_Service_Directory_Group
Update Group (groups.update)
convertToArrayAndStripNulls()  : mixed

Properties

$methods

private array<string|int, mixed> $methods

$resourceName

private string $resourceName

$serviceName

private string $serviceName

$servicePath

private string $servicePath

$stackParameters

private mixed $stackParameters = array('alt' => array('type' => 'string', 'location' => 'query'), 'fields' => array('type' => 'string', 'location' => 'query'), 'trace' => array('type' => 'string', 'location' => 'query'), 'userIp' => array('type' => 'string', 'location' => 'query'), 'quotaUser' => array('type' => 'string', 'location' => 'query'), 'data' => array('type' => 'string', 'location' => 'body'), 'mimeType' => array('type' => 'string', 'location' => 'header'), 'uploadType' => array('type' => 'string', 'location' => 'query'), 'mediaUpload' => array('type' => 'complex', 'location' => 'query'), 'prettyPrint' => array('type' => 'string', 'location' => 'query'))

Methods

__construct()

public __construct(mixed $service, mixed $serviceName, mixed $resourceName, mixed $resource) : mixed
Parameters
$service : mixed
$serviceName : mixed
$resourceName : mixed
$resource : mixed
Return values
mixed —

call()

TODO: This function needs simplifying.

public call( $name,  $arguments[,  $expectedClass = null ]) : Google_Http_Request|expectedClass
Parameters
$name :
$arguments :
$expectedClass : = null
  • optional, the expected class name
Tags
throws
Google_Exception
Return values
Google_Http_Request|expectedClass —

createRequestUri()

Parse/expand request parameters and create a fully qualified request uri.

public createRequestUri(string $restPath, array<string|int, mixed> $params) : string
Parameters
$restPath : string
$params : array<string|int, mixed>
Tags
static
Return values
string —

$requestUrl

delete()

Delete Group (groups.delete)

public delete(string $groupKey[, array<string|int, mixed> $optParams = array() ]) : mixed
Parameters
$groupKey : string

Email or immutable ID of the group

$optParams : array<string|int, mixed> = array()

Optional parameters.

Return values
mixed —

listGroups()

Retrieve all groups of a domain or of a user given a userKey (paginated) (groups.listGroups)

public listGroups([array<string|int, mixed> $optParams = array() ]) : Google_Service_Directory_Groups
Parameters
$optParams : array<string|int, mixed> = array()

Optional parameters.

Tags
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

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 it's an ID, it should match with the ID of the user object.

opt_param

string sortOrder Whether to return results in ascending or descending order. Only of use when orderBy is also used

opt_param

string customer Immutable ID of the G Suite account. In case of multi-domain, to fetch all groups for a customer, fill this field instead of domain.

opt_param

string orderBy Column to use for sorting results

opt_param

string pageToken Token to specify next page in the list

opt_param

int maxResults Maximum number of results to return. Max allowed value is 200.

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-groups

Return values
Google_Service_Directory_Groups —

patch()

Patch Groups via Apiary Patch Orchestration (groups.patch)

public patch(string $groupKey, Google_Service_Directory_Group $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Directory_Group
Parameters
$groupKey : string

Email or immutable ID of the group. If ID, it should match with id of group object

$postBody : Google_Service_Directory_Group
$optParams : array<string|int, mixed> = array()

Optional parameters.

Return values
Google_Service_Directory_Group —

convertToArrayAndStripNulls()

protected convertToArrayAndStripNulls(mixed $o) : mixed
Parameters
$o : mixed
Return values
mixed —

Search results