Google_Service_Directory_UsersAliases_Resource

The "aliases" 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_UsersAliases_Resource extends Google_Service_Resource 
  2.  
  3. /** 
  4. * Remove a alias for the user (aliases.delete) 
  5. * @param string $userKey Email or immutable Id of the user 
  6. * @param string $alias The alias to be removed 
  7. * @param array $optParams Optional parameters. 
  8. */ 
  9. public function delete($userKey, $alias, $optParams = array()) 
  10. $params = array('userKey' => $userKey, 'alias' => $alias); 
  11. $params = array_merge($params, $optParams); 
  12. return $this->call('delete', array($params)); 
  13.  
  14. /** 
  15. * Add a alias for the user (aliases.insert) 
  16. * @param string $userKey Email or immutable Id of the user 
  17. * @param Google_Alias $postBody 
  18. * @param array $optParams Optional parameters. 
  19. * @return Google_Service_Directory_Alias 
  20. */ 
  21. public function insert($userKey, Google_Service_Directory_Alias $postBody, $optParams = array()) 
  22. $params = array('userKey' => $userKey, 'postBody' => $postBody); 
  23. $params = array_merge($params, $optParams); 
  24. return $this->call('insert', array($params), "Google_Service_Directory_Alias"); 
  25.  
  26. /** 
  27. * List all aliases for a user (aliases.listUsersAliases) 
  28. * @param string $userKey Email or immutable Id of the user 
  29. * @param array $optParams Optional parameters. 
  30. * @opt_param string event Event on which subscription is intended (if 
  31. * subscribing) 
  32. * @return Google_Service_Directory_Aliases 
  33. */ 
  34. public function listUsersAliases($userKey, $optParams = array()) 
  35. $params = array('userKey' => $userKey); 
  36. $params = array_merge($params, $optParams); 
  37. return $this->call('list', array($params), "Google_Service_Directory_Aliases"); 
  38.  
  39. /** 
  40. * Watch for changes in user aliases list (aliases.watch) 
  41. * @param string $userKey Email or immutable Id of the user 
  42. * @param Google_Channel $postBody 
  43. * @param array $optParams Optional parameters. 
  44. * @opt_param string event Event on which subscription is intended (if 
  45. * subscribing) 
  46. * @return Google_Service_Directory_Channel 
  47. */ 
  48. public function watch($userKey, Google_Service_Directory_Channel $postBody, $optParams = array()) 
  49. $params = array('userKey' => $userKey, 'postBody' => $postBody); 
  50. $params = array_merge($params, $optParams); 
  51. return $this->call('watch', array($params), "Google_Service_Directory_Channel");