Moodle PHP Documentation 4.3
Moodle 4.3.5 (Build: 20240610) (7dcfaa79f78)
Google_Service_Directory_Members_Resource Class Reference

The "members" collection of methods. More...

Inheritance diagram for Google_Service_Directory_Members_Resource:
Google_Service_Resource

Public Member Functions

 call ($name, $arguments, $expected_class=null)
 TODO: This function needs simplifying.
 
 delete ($groupKey, $memberKey, $optParams=array())
 Remove membership.
 
 get ($groupKey, $memberKey, $optParams=array())
 Retrieve Group Member (members.get)
 
 insert ($groupKey, Google_Service_Directory_Member $postBody, $optParams=array())
 Add user to the specified group.
 
 listMembers ($groupKey, $optParams=array())
 Retrieve all members in a group (paginated) (members.listMembers)
 
 patch ($groupKey, $memberKey, Google_Service_Directory_Member $postBody, $optParams=array())
 Update membership of a user in the specified group.
 
 update ($groupKey, $memberKey, Google_Service_Directory_Member $postBody, $optParams=array())
 Update membership of a user in the specified group.
 

Protected Member Functions

 convertToArrayAndStripNulls ($o)
 

Detailed Description

The "members" collection of methods.

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

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

Remove membership.

(members.delete)

Parameters
string$groupKeyEmail or immutable Id of the group
string$memberKeyEmail or immutable Id of the member
array$optParamsOptional parameters.

◆ get()

Google_Service_Directory_Members_Resource::get ( $groupKey,
$memberKey,
$optParams = array() )

Retrieve Group Member (members.get)

Parameters
string$groupKeyEmail or immutable Id of the group
string$memberKeyEmail or immutable Id of the member
array$optParamsOptional parameters.
Return values
Google_Service_Directory_Member

◆ insert()

Google_Service_Directory_Members_Resource::insert ( $groupKey,
Google_Service_Directory_Member $postBody,
$optParams = array() )

Add user to the specified group.

(members.insert)

Parameters
string$groupKeyEmail or immutable Id of the group
Google_Member$postBody
array$optParamsOptional parameters.
Return values
Google_Service_Directory_Member

◆ listMembers()

Google_Service_Directory_Members_Resource::listMembers ( $groupKey,
$optParams = array() )

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

Parameters
string$groupKeyEmail or immutable Id of the group
array$optParamsOptional parameters.

@opt_param string pageToken Token to specify next page in the list @opt_param string roles Comma separated role values to filter list results on. @opt_param int maxResults Maximum number of results to return. Default is 200

Return values
Google_Service_Directory_Members

◆ patch()

Google_Service_Directory_Members_Resource::patch ( $groupKey,
$memberKey,
Google_Service_Directory_Member $postBody,
$optParams = array() )

Update membership of a user in the specified group.

This method supports patch semantics. (members.patch)

Parameters
string$groupKeyEmail or immutable Id of the group. If Id, it should match with id of group object
string$memberKeyEmail or immutable Id of the user. If Id, it should match with id of member object
Google_Member$postBody
array$optParamsOptional parameters.
Return values
Google_Service_Directory_Member

◆ update()

Google_Service_Directory_Members_Resource::update ( $groupKey,
$memberKey,
Google_Service_Directory_Member $postBody,
$optParams = array() )

Update membership of a user in the specified group.

(members.update)

Parameters
string$groupKeyEmail or immutable Id of the group. If Id, it should match with id of group object
string$memberKeyEmail or immutable Id of the user. If Id, it should match with id of member object
Google_Member$postBody
array$optParamsOptional parameters.
Return values
Google_Service_Directory_Member

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