Google_Service_Directory_Groups_Resource

The "groups" collection of methods.

Defined (1)

The class is defined in the following location(s).

/includes/api-libs/Google/Service/Directory.php  
  1. class Google_Service_Directory_Groups_Resource extends Google_Service_Resource 
  2.  
  3. /** 
  4. * Delete Group (groups.delete) 
  5. * @param string $groupKey Email or immutable Id of the group 
  6. * @param array $optParams Optional parameters. 
  7. */ 
  8. public function delete($groupKey, $optParams = array()) 
  9. $params = array('groupKey' => $groupKey); 
  10. $params = array_merge($params, $optParams); 
  11. return $this->call('delete', array($params)); 
  12.  
  13. /** 
  14. * Retrieve Group (groups.get) 
  15. * @param string $groupKey Email or immutable Id of the group 
  16. * @param array $optParams Optional parameters. 
  17. * @return Google_Service_Directory_Group 
  18. */ 
  19. public function get($groupKey, $optParams = array()) 
  20. $params = array('groupKey' => $groupKey); 
  21. $params = array_merge($params, $optParams); 
  22. return $this->call('get', array($params), "Google_Service_Directory_Group"); 
  23.  
  24. /** 
  25. * Create Group (groups.insert) 
  26. * @param Google_Group $postBody 
  27. * @param array $optParams Optional parameters. 
  28. * @return Google_Service_Directory_Group 
  29. */ 
  30. public function insert(Google_Service_Directory_Group $postBody, $optParams = array()) 
  31. $params = array('postBody' => $postBody); 
  32. $params = array_merge($params, $optParams); 
  33. return $this->call('insert', array($params), "Google_Service_Directory_Group"); 
  34.  
  35. /** 
  36. * Retrieve all groups in a domain (paginated) (groups.listGroups) 
  37. * @param array $optParams Optional parameters. 
  38. * @opt_param string customer Immutable id of the Google Apps account. In case 
  39. * of multi-domain, to fetch all groups for a customer, fill this field instead 
  40. * of domain. 
  41. * @opt_param string pageToken Token to specify next page in the list 
  42. * @opt_param string domain Name of the domain. Fill this field to get groups 
  43. * from only this domain. To return all groups in a multi-domain fill customer 
  44. * field instead. 
  45. * @opt_param int maxResults Maximum number of results to return. Default is 200 
  46. * @opt_param string userKey Email or immutable Id of the user if only those 
  47. * groups are to be listed, the given user is a member of. If Id, it should 
  48. * match with id of user object 
  49. * @return Google_Service_Directory_Groups 
  50. */ 
  51. public function listGroups($optParams = array()) 
  52. $params = array(); 
  53. $params = array_merge($params, $optParams); 
  54. return $this->call('list', array($params), "Google_Service_Directory_Groups"); 
  55.  
  56. /** 
  57. * Update Group. This method supports patch semantics. (groups.patch) 
  58. * @param string $groupKey Email or immutable Id of the group. If Id, it should 
  59. * match with id of group object 
  60. * @param Google_Group $postBody 
  61. * @param array $optParams Optional parameters. 
  62. * @return Google_Service_Directory_Group 
  63. */ 
  64. public function patch($groupKey, Google_Service_Directory_Group $postBody, $optParams = array()) 
  65. $params = array('groupKey' => $groupKey, 'postBody' => $postBody); 
  66. $params = array_merge($params, $optParams); 
  67. return $this->call('patch', array($params), "Google_Service_Directory_Group"); 
  68.  
  69. /** 
  70. * Update Group (groups.update) 
  71. * @param string $groupKey Email or immutable Id of the group. If Id, it should 
  72. * match with id of group object 
  73. * @param Google_Group $postBody 
  74. * @param array $optParams Optional parameters. 
  75. * @return Google_Service_Directory_Group 
  76. */ 
  77. public function update($groupKey, Google_Service_Directory_Group $postBody, $optParams = array()) 
  78. $params = array('groupKey' => $groupKey, 'postBody' => $postBody); 
  79. $params = array_merge($params, $optParams); 
  80. return $this->call('update', array($params), "Google_Service_Directory_Group");