Google_Service_Directory_Notifications_Resource

The "notifications" 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_Notifications_Resource extends Google_Service_Resource 
  2.  
  3. /** 
  4. * Deletes a notification (notifications.delete) 
  5. * @param string $customer The unique ID for the customer's Google account. The 
  6. * customerId is also returned as part of the Users resource. 
  7. * @param string $notificationId The unique ID of the notification. 
  8. * @param array $optParams Optional parameters. 
  9. */ 
  10. public function delete($customer, $notificationId, $optParams = array()) 
  11. $params = array('customer' => $customer, 'notificationId' => $notificationId); 
  12. $params = array_merge($params, $optParams); 
  13. return $this->call('delete', array($params)); 
  14.  
  15. /** 
  16. * Retrieves a notification. (notifications.get) 
  17. * @param string $customer The unique ID for the customer's Google account. The 
  18. * customerId is also returned as part of the Users resource. 
  19. * @param string $notificationId The unique ID of the notification. 
  20. * @param array $optParams Optional parameters. 
  21. * @return Google_Service_Directory_Notification 
  22. */ 
  23. public function get($customer, $notificationId, $optParams = array()) 
  24. $params = array('customer' => $customer, 'notificationId' => $notificationId); 
  25. $params = array_merge($params, $optParams); 
  26. return $this->call('get', array($params), "Google_Service_Directory_Notification"); 
  27.  
  28. /** 
  29. * Retrieves a list of notifications. (notifications.listNotifications) 
  30. * @param string $customer The unique ID for the customer's Google account. 
  31. * @param array $optParams Optional parameters. 
  32. * @opt_param string pageToken The token to specify the page of results to 
  33. * retrieve. 
  34. * @opt_param string maxResults Maximum number of notifications to return per 
  35. * page. The default is 100. 
  36. * @opt_param string language The ISO 639-1 code of the language notifications 
  37. * are returned in. The default is English (en). 
  38. * @return Google_Service_Directory_Notifications 
  39. */ 
  40. public function listNotifications($customer, $optParams = array()) 
  41. $params = array('customer' => $customer); 
  42. $params = array_merge($params, $optParams); 
  43. return $this->call('list', array($params), "Google_Service_Directory_Notifications"); 
  44.  
  45. /** 
  46. * Updates a notification. This method supports patch semantics. 
  47. * (notifications.patch) 
  48. * @param string $customer The unique ID for the customer's Google account. 
  49. * @param string $notificationId The unique ID of the notification. 
  50. * @param Google_Notification $postBody 
  51. * @param array $optParams Optional parameters. 
  52. * @return Google_Service_Directory_Notification 
  53. */ 
  54. public function patch($customer, $notificationId, Google_Service_Directory_Notification $postBody, $optParams = array()) 
  55. $params = array('customer' => $customer, 'notificationId' => $notificationId, 'postBody' => $postBody); 
  56. $params = array_merge($params, $optParams); 
  57. return $this->call('patch', array($params), "Google_Service_Directory_Notification"); 
  58.  
  59. /** 
  60. * Updates a notification. (notifications.update) 
  61. * @param string $customer The unique ID for the customer's Google account. 
  62. * @param string $notificationId The unique ID of the notification. 
  63. * @param Google_Notification $postBody 
  64. * @param array $optParams Optional parameters. 
  65. * @return Google_Service_Directory_Notification 
  66. */ 
  67. public function update($customer, $notificationId, Google_Service_Directory_Notification $postBody, $optParams = array()) 
  68. $params = array('customer' => $customer, 'notificationId' => $notificationId, 'postBody' => $postBody); 
  69. $params = array_merge($params, $optParams); 
  70. return $this->call('update', array($params), "Google_Service_Directory_Notification");