Documentation

Google_Service_Directory_Resource_Members extends Google_Service_Resource
in package

Application

The "members" collection of methods.

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

$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: Remove membership. (members.delete)
get() : Google_Service_Directory_Member: Retrieve Group Member (members.get)
hasMember() : Google_Service_Directory_MembersHasMember: Checks whether the given user is a member of the group. Membership can be direct or nested. (members.hasMember)
insert() : Google_Service_Directory_Member: Add user to the specified group. (members.insert)
listMembers() : Google_Service_Directory_Members: Retrieve all members in a group (paginated) (members.listMembers)
patch() : Google_Service_Directory_Member: Patch Member via Apiary Patch Orchestration (members.patch)
update() : Google_Service_Directory_Member: Update membership of a user in the specified group. (members.update)
convertToArrayAndStripNulls() : mixed

$client


    private
        Google_Client
    $client

$methods


    private
        array<string|int, mixed>
    $methods

$resourceName


    private
        string
    $resourceName

$rootUrl


    private
        string
    $rootUrl

$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'))

__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

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>

Return values

string —

$requestUrl

delete()

Remove membership. (members.delete)


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

Parameters

$groupKey : string: Email or immutable ID of the group
$memberKey : string: Email or immutable ID of the member
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

mixed —

get()

Retrieve Group Member (members.get)


    public
                get(string $groupKey, string $memberKey[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Directory_Member

Parameters

$groupKey : string: Email or immutable ID of the group
$memberKey : string: Email or immutable ID of the member
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_Directory_Member —

hasMember()

Checks whether the given user is a member of the group. Membership can be direct or nested. (members.hasMember)


    public
                hasMember(string $groupKey, string $memberKey[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Directory_MembersHasMember

Parameters

$groupKey : string: Identifies the group in the API request. The value can be the group's email address, group alias, or the unique group ID.
$memberKey : string: Identifies the user member in the API request. The value can be the user's primary email address, alias, or unique ID.
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_Directory_MembersHasMember —

insert()

Add user to the specified group. (members.insert)


    public
                insert(string $groupKey, Google_Service_Directory_Member $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Directory_Member

Parameters

$groupKey : string: Email or immutable ID of the group
$postBody : Google_Service_Directory_Member
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_Directory_Member —

listMembers()

Retrieve all members in a group (paginated) (members.listMembers)


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

Parameters

$groupKey : string: Email or immutable ID of the group
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_Directory_Members —

patch()

Patch Member via Apiary Patch Orchestration (members.patch)


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

Parameters

$groupKey : string: Email or immutable ID of the group. If ID, it should match with id of group object
$memberKey : string: Email or immutable ID of the user. If ID, it should match with id of member object
$postBody : Google_Service_Directory_Member
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_Directory_Member —

update()

Update membership of a user in the specified group. (members.update)


    public
                update(string $groupKey, string $memberKey, Google_Service_Directory_Member $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Directory_Member

Parameters

$groupKey : string: Email or immutable ID of the group. If ID, it should match with id of group object
$memberKey : string: Email or immutable ID of the user. If ID, it should match with id of member object
$postBody : Google_Service_Directory_Member
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_Directory_Member —

convertToArrayAndStripNulls()


    protected
                convertToArrayAndStripNulls(mixed $o) : mixed

Parameters

$o : mixed

Return values

mixed —