The "members" collection of methods.
More...
|
| 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.
|
|
|
| convertToArrayAndStripNulls ($o) |
|
The "members" collection of methods.
Typical usage is: $adminService = new Google_Service_Directory(...); $members = $adminService->members;
◆ 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
-
◆ delete()
Google_Service_Directory_Members_Resource::delete |
( |
| $groupKey, |
|
|
| $memberKey, |
|
|
| $optParams = array() ) |
Remove membership.
(members.delete)
- Parameters
-
string | $groupKey | Email or immutable Id of the group |
string | $memberKey | Email or immutable Id of the member |
array | $optParams | Optional parameters. |
◆ get()
Google_Service_Directory_Members_Resource::get |
( |
| $groupKey, |
|
|
| $memberKey, |
|
|
| $optParams = array() ) |
Retrieve Group Member (members.get)
- Parameters
-
string | $groupKey | Email or immutable Id of the group |
string | $memberKey | Email or immutable Id of the member |
array | $optParams | Optional parameters. |
- Return values
-
◆ insert()
Add user to the specified group.
(members.insert)
- Parameters
-
string | $groupKey | Email or immutable Id of the group |
Google_Member | $postBody | |
array | $optParams | Optional parameters. |
- Return values
-
◆ listMembers()
Google_Service_Directory_Members_Resource::listMembers |
( |
| $groupKey, |
|
|
| $optParams = array() ) |
Retrieve all members in a group (paginated) (members.listMembers)
- Parameters
-
string | $groupKey | Email or immutable Id of the group |
array | $optParams | Optional 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
-
◆ patch()
Update membership of a user in the specified group.
This method supports patch semantics. (members.patch)
- Parameters
-
string | $groupKey | Email or immutable Id of the group. If Id, it should match with id of group object |
string | $memberKey | Email or immutable Id of the user. If Id, it should match with id of member object |
Google_Member | $postBody | |
array | $optParams | Optional parameters. |
- Return values
-
◆ update()
Update membership of a user in the specified group.
(members.update)
- Parameters
-
string | $groupKey | Email or immutable Id of the group. If Id, it should match with id of group object |
string | $memberKey | Email or immutable Id of the user. If Id, it should match with id of member object |
Google_Member | $postBody | |
array | $optParams | Optional parameters. |
- Return values
-
The documentation for this class was generated from the following file:
- lib/google/src/Google/Service/Directory.php