Google_Service_Calendar_CalendarList_Resource Class Reference

The "calendarList" collection of methods. More...

Inheritance diagram for Google_Service_Calendar_CalendarList_Resource:

Public Member Functions
	call ($name, $arguments, $expected_class=null)
	TODO: This function needs simplifying.
	delete ($calendarId, $optParams=array())
	Deletes an entry on the user's calendar list.
	get ($calendarId, $optParams=array())
	Returns an entry on the user's calendar list.
	insert (Google_Service_Calendar_CalendarListEntry $postBody, $optParams=array())
	Adds an entry to the user's calendar list.
	listCalendarList ($optParams=array())
	Returns entries on the user's calendar list.
	patch ($calendarId, Google_Service_Calendar_CalendarListEntry $postBody, $optParams=array())
	Updates an entry on the user's calendar list.
	update ($calendarId, Google_Service_Calendar_CalendarListEntry $postBody, $optParams=array())
	Updates an entry on the user's calendar list.
	watch (Google_Service_Calendar_Channel $postBody, $optParams=array())
	Watch for changes to CalendarList resources.

Protected Member Functions
	convertToArrayAndStripNulls ($o)

Detailed Description

The "calendarList" collection of methods.

Typical usage is: $calendarService = new Google_Service_Calendar(...); $calendarList = $calendarService->calendarList;

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_Calendar_CalendarList_Resource::delete	(		$calendarId,
			$optParams = array() )

Deletes an entry on the user's calendar list.

(calendarList.delete)

Parameters

string	$calendarId	Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the "primary" keyword.
array	$optParams	Optional parameters.

get()

Google_Service_Calendar_CalendarList_Resource::get	(		$calendarId,
			$optParams = array() )

Returns an entry on the user's calendar list.

(calendarList.get)

Parameters

string	$calendarId	Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the "primary" keyword.
array	$optParams	Optional parameters.

Return values

Google_Service_Calendar_CalendarListEntry

insert()

Google_Service_Calendar_CalendarList_Resource::insert	(	Google_Service_Calendar_CalendarListEntry	$postBody,
			$optParams = array() )

Adds an entry to the user's calendar list.

(calendarList.insert)

Parameters

Google_CalendarListEntry	$postBody
array	$optParams	Optional parameters.

@opt_param bool colorRgbFormat Whether to use the foregroundColor and backgroundColor fields to write the calendar colors (RGB). If this feature is used, the index-based colorId field will be set to the best matching option automatically. Optional. The default is False.

Return values

Google_Service_Calendar_CalendarListEntry

listCalendarList()

Google_Service_Calendar_CalendarList_Resource::listCalendarList

(

$optParams = array()

)

Returns entries on the user's calendar list.

(calendarList.listCalendarList)

Parameters

array

$optParams

Optional parameters.

@opt_param string syncToken Token obtained from the nextSyncToken field returned on the last page of results from the previous list request. It makes the result of this list request contain only entries that have changed since then. If only read-only fields such as calendar properties or ACLs have changed, the entry won't be returned. All entries deleted and hidden since the previous list request will always be in the result set and it is not allowed to set showDeleted neither showHidden to False. To ensure client state consistency minAccessRole query parameter cannot be specified together with nextSyncToken. If the syncToken expires, the server will respond with a 410 GONE response code and the client should clear its storage and perform a full synchronization without any syncToken. Learn more about incremental synchronization. Optional. The default is to return all entries. @opt_param bool showDeleted Whether to include deleted calendar list entries in the result. Optional. The default is False. @opt_param string minAccessRole The minimum access role for the user in the returned entries. Optional. The default is no restriction. @opt_param int maxResults Maximum number of entries returned on one result page. By default the value is 100 entries. The page size can never be larger than 250 entries. Optional. @opt_param string pageToken Token specifying which result page to return. Optional. @opt_param bool showHidden Whether to show hidden entries. Optional. The default is False.

Return values

Google_Service_Calendar_CalendarList

patch()

Google_Service_Calendar_CalendarList_Resource::patch	(		$calendarId,
		Google_Service_Calendar_CalendarListEntry	$postBody,
			$optParams = array() )

Updates an entry on the user's calendar list.

This method supports patch semantics. (calendarList.patch)

Parameters

string	$calendarId	Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the "primary" keyword.
Google_CalendarListEntry	$postBody
array	$optParams	Optional parameters.

@opt_param bool colorRgbFormat Whether to use the foregroundColor and backgroundColor fields to write the calendar colors (RGB). If this feature is used, the index-based colorId field will be set to the best matching option automatically. Optional. The default is False.

Return values

Google_Service_Calendar_CalendarListEntry

update()

Google_Service_Calendar_CalendarList_Resource::update	(		$calendarId,
		Google_Service_Calendar_CalendarListEntry	$postBody,
			$optParams = array() )

Updates an entry on the user's calendar list.

(calendarList.update)

Parameters

string	$calendarId	Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the "primary" keyword.
Google_CalendarListEntry	$postBody
array	$optParams	Optional parameters.

@opt_param bool colorRgbFormat Whether to use the foregroundColor and backgroundColor fields to write the calendar colors (RGB). If this feature is used, the index-based colorId field will be set to the best matching option automatically. Optional. The default is False.

Return values

Google_Service_Calendar_CalendarListEntry

watch()

Google_Service_Calendar_CalendarList_Resource::watch	(	Google_Service_Calendar_Channel	$postBody,
			$optParams = array() )

Watch for changes to CalendarList resources.

(calendarList.watch)

Parameters

Google_Channel	$postBody
array	$optParams	Optional parameters.

@opt_param string syncToken Token obtained from the nextSyncToken field returned on the last page of results from the previous list request. It makes the result of this list request contain only entries that have changed since then. If only read-only fields such as calendar properties or ACLs have changed, the entry won't be returned. All entries deleted and hidden since the previous list request will always be in the result set and it is not allowed to set showDeleted neither showHidden to False. To ensure client state consistency minAccessRole query parameter cannot be specified together with nextSyncToken. If the syncToken expires, the server will respond with a 410 GONE response code and the client should clear its storage and perform a full synchronization without any syncToken. Learn more about incremental synchronization. Optional. The default is to return all entries. @opt_param bool showDeleted Whether to include deleted calendar list entries in the result. Optional. The default is False. @opt_param string minAccessRole The minimum access role for the user in the returned entries. Optional. The default is no restriction. @opt_param int maxResults Maximum number of entries returned on one result page. By default the value is 100 entries. The page size can never be larger than 250 entries. Optional. @opt_param string pageToken Token specifying which result page to return. Optional. @opt_param bool showHidden Whether to show hidden entries. Optional. The default is False.

Return values

Google_Service_Calendar_Channel

---

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

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