Google_MembersServiceResource
The "members" collection of methods.
Defined (1)
The class is defined in the following location(s).
- /src/contrib/Google_DirectoryService.php
- class Google_MembersServiceResource extends Google_ServiceResource {
- /**
- * Remove membership. (members.delete)
- *
- * @param string $groupKey Email or immutable Id of the group
- * @param string $memberKey Email or immutable Id of the member
- * @param array $optParams Optional parameters.
- */
- public function delete($groupKey, $memberKey, $optParams = array()) {
- $params = array('groupKey' => $groupKey, 'memberKey' => $memberKey);
- $params = array_merge($params, $optParams);
- $data = $this->__call('delete', array($params));
- return $data;
- }
- /**
- * Retrieve Group Member (members.get)
- *
- * @param string $groupKey Email or immutable Id of the group
- * @param string $memberKey Email or immutable Id of the member
- * @param array $optParams Optional parameters.
- * @return Google_Member
- */
- public function get($groupKey, $memberKey, $optParams = array()) {
- $params = array('groupKey' => $groupKey, 'memberKey' => $memberKey);
- $params = array_merge($params, $optParams);
- $data = $this->__call('get', array($params));
- if ($this->useObjects()) {
- return new Google_Member($data);
- } else {
- return $data;
- }
- }
- /**
- * Add user to the specified group. (members.insert)
- *
- * @param string $groupKey Email or immutable Id of the group
- * @param Google_Member $postBody
- * @param array $optParams Optional parameters.
- * @return Google_Member
- */
- public function insert($groupKey, Google_Member $postBody, $optParams = array()) {
- $params = array('groupKey' => $groupKey, 'postBody' => $postBody);
- $params = array_merge($params, $optParams);
- $data = $this->__call('insert', array($params));
- if ($this->useObjects()) {
- return new Google_Member($data);
- } else {
- return $data;
- }
- }
- /**
- * Retrieve all members in a group (paginated) (members.list)
- *
- * @param string $groupKey Email or immutable Id of the group
- * @param array $optParams Optional parameters.
- *
- * @opt_param int maxResults Maximum number of results to return. Default is 200
- * @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.
- * @return Google_Members
- */
- public function listMembers($groupKey, $optParams = array()) {
- $params = array('groupKey' => $groupKey);
- $params = array_merge($params, $optParams);
- $data = $this->__call('list', array($params));
- if ($this->useObjects()) {
- return new Google_Members($data);
- } else {
- return $data;
- }
- }
- /**
- * Update membership of a user in the specified group. This method supports patch semantics.
- * (members.patch)
- *
- * @param string $groupKey Email or immutable Id of the group. If Id, it should match with id of group object
- * @param string $memberKey Email or immutable Id of the user. If Id, it should match with id of member object
- * @param Google_Member $postBody
- * @param array $optParams Optional parameters.
- * @return Google_Member
- */
- public function patch($groupKey, $memberKey, Google_Member $postBody, $optParams = array()) {
- $params = array('groupKey' => $groupKey, 'memberKey' => $memberKey, 'postBody' => $postBody);
- $params = array_merge($params, $optParams);
- $data = $this->__call('patch', array($params));
- if ($this->useObjects()) {
- return new Google_Member($data);
- } else {
- return $data;
- }
- }
- /**
- * Update membership of a user in the specified group. (members.update)
- *
- * @param string $groupKey Email or immutable Id of the group. If Id, it should match with id of group object
- * @param string $memberKey Email or immutable Id of the user. If Id, it should match with id of member object
- * @param Google_Member $postBody
- * @param array $optParams Optional parameters.
- * @return Google_Member
- */
- public function update($groupKey, $memberKey, Google_Member $postBody, $optParams = array()) {
- $params = array('groupKey' => $groupKey, 'memberKey' => $memberKey, 'postBody' => $postBody);
- $params = array_merge($params, $optParams);
- $data = $this->__call('update', array($params));
- if ($this->useObjects()) {
- return new Google_Member($data);
- } else {
- return $data;
- }
- }
- }