Google_Service_Calendar_Calendars_Resource Class Reference

The "calendars" collection of methods. More...

Inheritance diagram for Google_Service_Calendar_Calendars_Resource:

Public Member Functions
	call ($name, $arguments, $expected_class=null)
	TODO: This function needs simplifying.
	clear ($calendarId, $optParams=array())
	Clears a primary calendar.
	delete ($calendarId, $optParams=array())
	Deletes a secondary calendar.
	get ($calendarId, $optParams=array())
	Returns metadata for a calendar.
	insert (Google_Service_Calendar_Calendar $postBody, $optParams=array())
	Creates a secondary calendar.
	patch ($calendarId, Google_Service_Calendar_Calendar $postBody, $optParams=array())
	Updates metadata for a calendar.
	update ($calendarId, Google_Service_Calendar_Calendar $postBody, $optParams=array())
	Updates metadata for a calendar.

Protected Member Functions
	convertToArrayAndStripNulls ($o)

Detailed Description

The "calendars" collection of methods.

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

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

clear()

Google_Service_Calendar_Calendars_Resource::clear	(		$calendarId,
			$optParams = array() )

Clears a primary calendar.

This operation deletes all events associated with the primary calendar of an account. (calendars.clear)

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.

delete()

Google_Service_Calendar_Calendars_Resource::delete	(		$calendarId,
			$optParams = array() )

Deletes a secondary calendar.

Use calendars.clear for clearing all events on primary calendars. (calendars.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_Calendars_Resource::get	(		$calendarId,
			$optParams = array() )

Returns metadata for a calendar.

(calendars.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_Calendar

insert()

Google_Service_Calendar_Calendars_Resource::insert	(	Google_Service_Calendar_Calendar	$postBody,
			$optParams = array() )

Creates a secondary calendar.

(calendars.insert)

Parameters

Google_Calendar	$postBody
array	$optParams	Optional parameters.

Return values

Google_Service_Calendar_Calendar

patch()

Google_Service_Calendar_Calendars_Resource::patch	(		$calendarId,
		Google_Service_Calendar_Calendar	$postBody,
			$optParams = array() )

Updates metadata for a calendar.

This method supports patch semantics. (calendars.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_Calendar	$postBody
array	$optParams	Optional parameters.

Return values

Google_Service_Calendar_Calendar

update()

Google_Service_Calendar_Calendars_Resource::update	(		$calendarId,
		Google_Service_Calendar_Calendar	$postBody,
			$optParams = array() )

Updates metadata for a calendar.

(calendars.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_Calendar	$postBody
array	$optParams	Optional parameters.

Return values

Google_Service_Calendar_Calendar

---

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

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