The "members" collection of methods. Typical usage is:
$adminService = new Google_Service_Directory(...);
$members = $adminService->members;
Methods summary
public
|
#
delete( string $groupKey, string $memberKey, array $optParams = array() )
Remove membership. (members.delete)
Remove membership. (members.delete)
Parameters
- $groupKey
- Email or immutable ID of the group
- $memberKey
- Email or immutable ID of the member
- $optParams
- Optional parameters.
|
public
Google_Service_Directory_Member
|
#
get( string $groupKey, string $memberKey, array $optParams = array() )
Retrieve Group Member (members.get)
Retrieve Group Member (members.get)
Parameters
- $groupKey
- Email or immutable ID of the group
- $memberKey
- Email or immutable ID of the member
- $optParams
- Optional parameters.
Returns
|
public
Google_Service_Directory_MembersHasMember
|
#
hasMember( string $groupKey, string $memberKey, array $optParams = array() )
Checks whether the given user is a member of the group. Membership can be
direct or nested. (members.hasMember)
Checks whether the given user is a member of the group. Membership can be
direct or nested. (members.hasMember)
Parameters
- $groupKey
- Identifies the group in the API request. The value can be the group's email
address, group alias, or the unique group ID.
- $memberKey
- Identifies the user member in the API request. The value can be the user's
primary email address, alias, or unique ID.
- $optParams
- Optional parameters.
Returns
|
public
Google_Service_Directory_Member
|
#
insert( string $groupKey, Google_Service_Directory_Member $postBody, array $optParams = array() )
Add user to the specified group. (members.insert)
Add user to the specified group. (members.insert)
Parameters
- $groupKey
- Email or immutable ID of the group
- $postBody
- $optParams
- Optional parameters.
Returns
|
public
Google_Service_Directory_Members
|
#
listMembers( string $groupKey, array $optParams = array() )
Retrieve all members in a group (paginated) (members.listMembers)
Retrieve all members in a group (paginated) (members.listMembers)
Parameters
- $groupKey
- Email or immutable ID of the group
- $optParams
- Optional parameters.
Returns
Opt_param
bool includeDerivedMembership Whether to list indirect memberships. Default:
false.
int maxResults Maximum number of results to return. Max allowed value is 200.
string pageToken Token to specify next page in the list
string roles Comma separated role values to filter list results on.
|
public
Google_Service_Directory_Member
|
#
patch( string $groupKey, string $memberKey, Google_Service_Directory_Member $postBody, array $optParams = array() )
Update membership of a user in the specified group. This method supports
patch semantics. (members.patch)
Update membership of a user in the specified group. This method supports
patch semantics. (members.patch)
Parameters
- $groupKey
- Email or immutable ID of the group. If ID, it should match with id of group
object
- $memberKey
- Email or immutable ID of the user. If ID, it should match with id of member
object
- $postBody
- $optParams
- Optional parameters.
Returns
|
public
Google_Service_Directory_Member
|
#
update( string $groupKey, string $memberKey, Google_Service_Directory_Member $postBody, array $optParams = array() )
Update membership of a user in the specified group. (members.update)
Update membership of a user in the specified group. (members.update)
Parameters
- $groupKey
- Email or immutable ID of the group. If ID, it should match with id of group
object
- $memberKey
- Email or immutable ID of the user. If ID, it should match with id of member
object
- $postBody
- $optParams
- Optional parameters.
Returns
|