Google_Service_Directory_Notifications_Resource Class Reference

The "notifications" collection of methods. More...

Inheritance diagram for Google_Service_Directory_Notifications_Resource:

Public Member Functions
	call ($name, $arguments, $expected_class=null)
	TODO: This function needs simplifying.
	delete ($customer, $notificationId, $optParams=array())
	Deletes a notification (notifications.delete)
	get ($customer, $notificationId, $optParams=array())
	Retrieves a notification.
	listNotifications ($customer, $optParams=array())
	Retrieves a list of notifications.
	patch ($customer, $notificationId, Google_Service_Directory_Notification $postBody, $optParams=array())
	Updates a notification.
	update ($customer, $notificationId, Google_Service_Directory_Notification $postBody, $optParams=array())
	Updates a notification.

Protected Member Functions
	convertToArrayAndStripNulls ($o)

Detailed Description

The "notifications" collection of methods.

Typical usage is: $adminService = new Google_Service_Directory(...); $notifications = $adminService->notifications;

Member Function Documentation

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

Google_Exception

delete()

Google_Service_Directory_Notifications_Resource::delete	(		$customer,
			$notificationId,
			$optParams = array() )

Deletes a notification (notifications.delete)

Parameters

string	$customer	The unique ID for the customer's Google account. The customerId is also returned as part of the Users resource.
string	$notificationId	The unique ID of the notification.
array	$optParams	Optional parameters.

get()

Google_Service_Directory_Notifications_Resource::get	(		$customer,
			$notificationId,
			$optParams = array() )

Retrieves a notification.

(notifications.get)

Parameters

string	$customer	The unique ID for the customer's Google account. The customerId is also returned as part of the Users resource.
string	$notificationId	The unique ID of the notification.
array	$optParams	Optional parameters.

Return values

Google_Service_Directory_Notification

listNotifications()

Google_Service_Directory_Notifications_Resource::listNotifications	(		$customer,
			$optParams = array() )

Retrieves a list of notifications.

(notifications.listNotifications)

Parameters

string	$customer	The unique ID for the customer's Google account.
array	$optParams	Optional parameters.

@opt_param string pageToken The token to specify the page of results to retrieve. @opt_param string maxResults Maximum number of notifications to return per page. The default is 100. @opt_param string language The ISO 639-1 code of the language notifications are returned in. The default is English (en).

Return values

Google_Service_Directory_Notifications

patch()

Google_Service_Directory_Notifications_Resource::patch	(		$customer,
			$notificationId,
		Google_Service_Directory_Notification	$postBody,
			$optParams = array() )

Updates a notification.

This method supports patch semantics. (notifications.patch)

Parameters

string	$customer	The unique ID for the customer's Google account.
string	$notificationId	The unique ID of the notification.
Google_Notification	$postBody
array	$optParams	Optional parameters.

Return values

Google_Service_Directory_Notification

update()

Google_Service_Directory_Notifications_Resource::update	(		$customer,
			$notificationId,
		Google_Service_Directory_Notification	$postBody,
			$optParams = array() )

Updates a notification.

(notifications.update)

Parameters

string	$customer	The unique ID for the customer's Google account.
string	$notificationId	The unique ID of the notification.
Google_Notification	$postBody
array	$optParams	Optional parameters.

Return values

Google_Service_Directory_Notification

---

The documentation for this class was generated from the following file:

• lib/google/src/Google/Service/Directory.php