The "events" collection of methods. More...

Inheritance diagram for Google_Service_Calendar_Events_Resource:

Public Member Functions
	call ($name, $arguments, $expected_class=null)
	TODO: This function needs simplifying.

	delete ($calendarId, $eventId, $optParams=array())
	Deletes an event.

	get ($calendarId, $eventId, $optParams=array())
	Returns an event.

	import ($calendarId, Google_Service_Calendar_Event $postBody, $optParams=array())
	Imports an event.

	insert ($calendarId, Google_Service_Calendar_Event $postBody, $optParams=array())
	Creates an event.

	instances ($calendarId, $eventId, $optParams=array())
	Returns instances of the specified recurring event.

	listEvents ($calendarId, $optParams=array())
	Returns events on the specified calendar.

	move ($calendarId, $eventId, $destination, $optParams=array())
	Moves an event to another calendar, i.e.

	patch ($calendarId, $eventId, Google_Service_Calendar_Event $postBody, $optParams=array())
	Updates an event.

	quickAdd ($calendarId, $text, $optParams=array())
	Creates an event based on a simple text string.

	update ($calendarId, $eventId, Google_Service_Calendar_Event $postBody, $optParams=array())
	Updates an event.

	watch ($calendarId, Google_Service_Calendar_Channel $postBody, $optParams=array())
	Watch for changes to Events resources.

Protected Member Functions
	convertToArrayAndStripNulls ($o)

Detailed Description

The "events" collection of methods.

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

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

Deletes an event.

(events.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.
string	$eventId	Event identifier.
array	$optParams	Optional parameters.

@opt_param bool sendNotifications Whether to send notifications about the deletion of the event. Optional. The default is False.

◆ get()

Google_Service_Calendar_Events_Resource::get	(	$calendarId,
		$eventId,
		$optParams = array() )

Returns an event.

(events.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.
string	$eventId	Event identifier.
array	$optParams	Optional parameters.

@opt_param string timeZone Time zone used in the response. Optional. The default is the time zone of the calendar. @opt_param bool alwaysIncludeEmail Whether to always include a value in the email field for the organizer, creator and attendees, even if no real email is available (i.e. a generated, non-working value will be provided). The use of this option is discouraged and should only be used by clients which cannot handle the absence of an email address value in the mentioned places. Optional. The default is False. @opt_param int maxAttendees The maximum number of attendees to include in the response. If there are more than the specified number of attendees, only the participant is returned. Optional.

Return values

Google_Service_Calendar_Event

◆ import()

Google_Service_Calendar_Events_Resource::import	(		$calendarId,
		Google_Service_Calendar_Event	$postBody,
			$optParams = array() )

Imports an event.

This operation is used to add a private copy of an existing event to a calendar. (events.import)

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_Event	$postBody
array	$optParams	Optional parameters.

@opt_param bool supportsAttachments Whether API client performing operation supports event attachments. Optional. The default is False.

Return values

Google_Service_Calendar_Event

◆ insert()

Google_Service_Calendar_Events_Resource::insert	(		$calendarId,
		Google_Service_Calendar_Event	$postBody,
			$optParams = array() )

Creates an event.

(events.insert)

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_Event	$postBody
array	$optParams	Optional parameters.

@opt_param bool supportsAttachments Whether API client performing operation supports event attachments. Optional. The default is False. @opt_param bool sendNotifications Whether to send notifications about the creation of the new event. Optional. The default is False. @opt_param int maxAttendees The maximum number of attendees to include in the response. If there are more than the specified number of attendees, only the participant is returned. Optional.

Return values

Google_Service_Calendar_Event

◆ instances()

Google_Service_Calendar_Events_Resource::instances	(	$calendarId,
		$eventId,
		$optParams = array() )

Returns instances of the specified recurring event.

(events.instances)

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.
string	$eventId	Recurring event identifier.
array	$optParams	Optional parameters.

@opt_param bool showDeleted Whether to include deleted events (with status equals "cancelled") in the result. Cancelled instances of recurring events will still be included if singleEvents is False. Optional. The default is False. @opt_param string timeMax Upper bound (exclusive) for an event's start time to filter by. Optional. The default is not to filter by start time. Must be an RFC3339 timestamp with mandatory time zone offset. @opt_param bool alwaysIncludeEmail Whether to always include a value in the email field for the organizer, creator and attendees, even if no real email is available (i.e. a generated, non-working value will be provided). The use of this option is discouraged and should only be used by clients which cannot handle the absence of an email address value in the mentioned places. Optional. The default is False. @opt_param int maxResults Maximum number of events returned on one result page. By default the value is 250 events. The page size can never be larger than 2500 events. Optional. @opt_param string pageToken Token specifying which result page to return. Optional. @opt_param string timeMin Lower bound (inclusive) for an event's end time to filter by. Optional. The default is not to filter by end time. Must be an RFC3339 timestamp with mandatory time zone offset. @opt_param string timeZone Time zone used in the response. Optional. The default is the time zone of the calendar. @opt_param string originalStart The original start time of the instance in the result. Optional. @opt_param int maxAttendees The maximum number of attendees to include in the response. If there are more than the specified number of attendees, only the participant is returned. Optional.

Return values

Google_Service_Calendar_Events

◆ listEvents()

Google_Service_Calendar_Events_Resource::listEvents	(		$calendarId,
			$optParams = array() )

Returns events on the specified calendar.

(events.listEvents)

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.

@opt_param string orderBy The order of the events returned in the result. Optional. The default is an unspecified, stable order. @opt_param bool showHiddenInvitations Whether to include hidden invitations in the result. Optional. The default is False. @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. All events deleted since the previous list request will always be in the result set and it is not allowed to set showDeleted to False. There are several query parameters that cannot be specified together with nextSyncToken to ensure consistency of the client state.

These are: - iCalUID - orderBy - privateExtendedProperty - q - sharedExtendedProperty - timeMin - timeMax - updatedMin 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 events (with status equals "cancelled") in the result. Cancelled instances of recurring events (but not the underlying recurring event) will still be included if showDeleted and singleEvents are both False. If showDeleted and singleEvents are both True, only single instances of deleted events (but not the underlying recurring events) are returned. Optional. The default is False. @opt_param string iCalUID Specifies event ID in the iCalendar format to be included in the response. Optional. @opt_param string updatedMin Lower bound for an event's last modification time (as a RFC3339 timestamp) to filter by. When specified, entries deleted since this time will always be included regardless of showDeleted. Optional. The default is not to filter by last modification time. @opt_param bool singleEvents Whether to expand recurring events into instances and only return single one-off events and instances of recurring events, but not the underlying recurring events themselves. Optional. The default is False. @opt_param string timeMax Upper bound (exclusive) for an event's start time to filter by. Optional. The default is not to filter by start time. Must be an RFC3339 timestamp with mandatory time zone offset, e.g., 2011-06-03T10:00:00-07:00, 2011-06-03T10:00:00Z. Milliseconds may be provided but will be ignored. @opt_param bool alwaysIncludeEmail Whether to always include a value in the email field for the organizer, creator and attendees, even if no real email is available (i.e. a generated, non-working value will be provided). The use of this option is discouraged and should only be used by clients which cannot handle the absence of an email address value in the mentioned places. Optional. The default is False. @opt_param int maxResults Maximum number of events returned on one result page. By default the value is 250 events. The page size can never be larger than 2500 events. Optional. @opt_param string q Free text search terms to find events that match these terms in any field, except for extended properties. Optional. @opt_param string pageToken Token specifying which result page to return. Optional. @opt_param string timeMin Lower bound (inclusive) for an event's end time to filter by. Optional. The default is not to filter by end time. Must be an RFC3339 timestamp with mandatory time zone offset, e.g., 2011-06-03T10:00:00-07:00, 2011-06-03T10:00:00Z. Milliseconds may be provided but will be ignored. @opt_param string timeZone Time zone used in the response. Optional. The default is the time zone of the calendar. @opt_param string privateExtendedProperty Extended properties constraint specified as propertyName=value. Matches only private properties. This parameter might be repeated multiple times to return events that match all given constraints. @opt_param string sharedExtendedProperty Extended properties constraint specified as propertyName=value. Matches only shared properties. This parameter might be repeated multiple times to return events that match all given constraints. @opt_param int maxAttendees The maximum number of attendees to include in the response. If there are more than the specified number of attendees, only the participant is returned. Optional.

Return values

Google_Service_Calendar_Events

◆ move()

Google_Service_Calendar_Events_Resource::move	(	$calendarId,
		$eventId,
		$destination,
		$optParams = array() )

Moves an event to another calendar, i.e.

changes an event's organizer. (events.move)

Parameters

string	$calendarId	Calendar identifier of the source calendar where the event currently is on.
string	$eventId	Event identifier.
string	$destination	Calendar identifier of the target calendar where the event is to be moved to.
array	$optParams	Optional parameters.

@opt_param bool sendNotifications Whether to send notifications about the change of the event's organizer. Optional. The default is False.

Return values

Google_Service_Calendar_Event

◆ patch()

Google_Service_Calendar_Events_Resource::patch	(		$calendarId,
			$eventId,
		Google_Service_Calendar_Event	$postBody,
			$optParams = array() )

Updates an event.

This method supports patch semantics. (events.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.
string	$eventId	Event identifier.
Google_Event	$postBody
array	$optParams	Optional parameters.

@opt_param bool sendNotifications Whether to send notifications about the event update (e.g. attendee's responses, title changes, etc.). Optional. The default is False. @opt_param bool alwaysIncludeEmail Whether to always include a value in the email field for the organizer, creator and attendees, even if no real email is available (i.e. a generated, non-working value will be provided). The use of this option is discouraged and should only be used by clients which cannot handle the absence of an email address value in the mentioned places. Optional. The default is False. @opt_param bool supportsAttachments Whether API client performing operation supports event attachments. Optional. The default is False. @opt_param int maxAttendees The maximum number of attendees to include in the response. If there are more than the specified number of attendees, only the participant is returned. Optional.

Return values

Google_Service_Calendar_Event

◆ quickAdd()

Google_Service_Calendar_Events_Resource::quickAdd	(	$calendarId,
		$text,
		$optParams = array() )

Creates an event based on a simple text string.

(events.quickAdd)

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.
string	$text	The text describing the event to be created.
array	$optParams	Optional parameters.

@opt_param bool sendNotifications Whether to send notifications about the creation of the event. Optional. The default is False.

Return values

Google_Service_Calendar_Event

◆ update()

Google_Service_Calendar_Events_Resource::update	(		$calendarId,
			$eventId,
		Google_Service_Calendar_Event	$postBody,
			$optParams = array() )

Updates an event.

(events.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.
string	$eventId	Event identifier.
Google_Event	$postBody
array	$optParams	Optional parameters.

@opt_param bool sendNotifications Whether to send notifications about the event update (e.g. attendee's responses, title changes, etc.). Optional. The default is False. @opt_param bool alwaysIncludeEmail Whether to always include a value in the email field for the organizer, creator and attendees, even if no real email is available (i.e. a generated, non-working value will be provided). The use of this option is discouraged and should only be used by clients which cannot handle the absence of an email address value in the mentioned places. Optional. The default is False. @opt_param bool supportsAttachments Whether API client performing operation supports event attachments. Optional. The default is False. @opt_param int maxAttendees The maximum number of attendees to include in the response. If there are more than the specified number of attendees, only the participant is returned. Optional.

Return values

Google_Service_Calendar_Event

◆ watch()

Google_Service_Calendar_Events_Resource::watch	(		$calendarId,
		Google_Service_Calendar_Channel	$postBody,
			$optParams = array() )

Watch for changes to Events resources.

(events.watch)

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_Channel	$postBody
array	$optParams	Optional parameters.

@opt_param string orderBy The order of the events returned in the result. Optional. The default is an unspecified, stable order. @opt_param bool showHiddenInvitations Whether to include hidden invitations in the result. Optional. The default is False. @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. All events deleted since the previous list request will always be in the result set and it is not allowed to set showDeleted to False. There are several query parameters that cannot be specified together with nextSyncToken to ensure consistency of the client state.

These are: - iCalUID - orderBy - privateExtendedProperty - q - sharedExtendedProperty - timeMin - timeMax - updatedMin 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 events (with status equals "cancelled") in the result. Cancelled instances of recurring events (but not the underlying recurring event) will still be included if showDeleted and singleEvents are both False. If showDeleted and singleEvents are both True, only single instances of deleted events (but not the underlying recurring events) are returned. Optional. The default is False. @opt_param string iCalUID Specifies event ID in the iCalendar format to be included in the response. Optional. @opt_param string updatedMin Lower bound for an event's last modification time (as a RFC3339 timestamp) to filter by. When specified, entries deleted since this time will always be included regardless of showDeleted. Optional. The default is not to filter by last modification time. @opt_param bool singleEvents Whether to expand recurring events into instances and only return single one-off events and instances of recurring events, but not the underlying recurring events themselves. Optional. The default is False. @opt_param string timeMax Upper bound (exclusive) for an event's start time to filter by. Optional. The default is not to filter by start time. Must be an RFC3339 timestamp with mandatory time zone offset, e.g., 2011-06-03T10:00:00-07:00, 2011-06-03T10:00:00Z. Milliseconds may be provided but will be ignored. @opt_param bool alwaysIncludeEmail Whether to always include a value in the email field for the organizer, creator and attendees, even if no real email is available (i.e. a generated, non-working value will be provided). The use of this option is discouraged and should only be used by clients which cannot handle the absence of an email address value in the mentioned places. Optional. The default is False. @opt_param int maxResults Maximum number of events returned on one result page. By default the value is 250 events. The page size can never be larger than 2500 events. Optional. @opt_param string q Free text search terms to find events that match these terms in any field, except for extended properties. Optional. @opt_param string pageToken Token specifying which result page to return. Optional. @opt_param string timeMin Lower bound (inclusive) for an event's end time to filter by. Optional. The default is not to filter by end time. Must be an RFC3339 timestamp with mandatory time zone offset, e.g., 2011-06-03T10:00:00-07:00, 2011-06-03T10:00:00Z. Milliseconds may be provided but will be ignored. @opt_param string timeZone Time zone used in the response. Optional. The default is the time zone of the calendar. @opt_param string privateExtendedProperty Extended properties constraint specified as propertyName=value. Matches only private properties. This parameter might be repeated multiple times to return events that match all given constraints. @opt_param string sharedExtendedProperty Extended properties constraint specified as propertyName=value. Matches only shared properties. This parameter might be repeated multiple times to return events that match all given constraints. @opt_param int maxAttendees The maximum number of attendees to include in the response. If there are more than the specified number of attendees, only the participant is returned. Optional.

Return values

Google_Service_Calendar_Channel

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

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

Public Member Functions

Protected Member Functions

Detailed Description

Member Function Documentation

◆ call()

◆ delete()

◆ get()

◆ import()

◆ insert()

◆ instances()

◆ listEvents()

◆ move()

◆ patch()

◆ quickAdd()

◆ update()

◆ watch()