Class Google_Service_Calendar_Events_Resource
The "events" collection of methods. Typical usage is:
$calendarService = new Google_Service_Calendar(...); $events = $calendarService->events;
- Google_Service_Resource
- Google_Service_Calendar_Events_Resource
public
|
#
delete( string $calendarId, string $eventId, array $optParams = array() )
Deletes an event. (events.delete) Deletes an event. (events.delete) Parameters
Opt_param
bool sendNotifications Deprecated. Please use sendUpdates instead. Whether to
send notifications about the deletion of the event. Note that some emails might
still be sent even if you set the value to false. The default is false.
string sendUpdates Guests who should receive notifications about the deletion of the event. |
public
|
#
get( string $calendarId, string $eventId, array $optParams = array() )
Returns an event. (events.get) Returns an event. (events.get) Parameters
ReturnsOpt_param
bool alwaysIncludeEmail Deprecated and ignored. A value will always be returned
in the email field for the organizer, creator and attendees, even if no real
email address is available (i.e. a generated, non- working value will be
provided).
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. string timeZone Time zone used in the response. Optional. The default is the time zone of the calendar. |
public
|
#
import( string $calendarId,
Imports an event. This operation is used to add a private copy of an existing event to a calendar. (events.import) Imports an event. This operation is used to add a private copy of an existing event to a calendar. (events.import) Parameters
ReturnsOpt_param
int conferenceDataVersion Version number of conference data supported by the API
client. Version 0 assumes no conference data support and ignores conference data
in the event's body. Version 1 enables support for copying of ConferenceData as
well as for creating new conferences using the createRequest field of
conferenceData. The default is 0.
bool supportsAttachments Whether API client performing operation supports event attachments. Optional. The default is False. |
public
|
#
insert( string $calendarId,
Creates an event. (events.insert) Creates an event. (events.insert) Parameters
ReturnsOpt_param
int conferenceDataVersion Version number of conference data supported by the API
client. Version 0 assumes no conference data support and ignores conference data
in the event's body. Version 1 enables support for copying of ConferenceData as
well as for creating new conferences using the createRequest field of
conferenceData. The default is 0.
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. bool sendNotifications Deprecated. Please use sendUpdates instead. Whether to send notifications about the creation of the new event. Note that some emails might still be sent even if you set the value to false. The default is false. string sendUpdates Whether to send notifications about the creation of the new event. Note that some emails might still be sent. The default is false. bool supportsAttachments Whether API client performing operation supports event attachments. Optional. The default is False. |
public
|
#
instances( string $calendarId, string $eventId, array $optParams = array() )
Returns instances of the specified recurring event. (events.instances) Returns instances of the specified recurring event. (events.instances) Parameters
ReturnsOpt_param
bool alwaysIncludeEmail Deprecated and ignored. A value will always be returned
in the email field for the organizer, creator and attendees, even if no real
email address is available (i.e. a generated, non- working value will be
provided).
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. 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. string originalStart The original start time of the instance in the result. Optional. string pageToken Token specifying which result page to return. Optional. 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. 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. 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. string timeZone Time zone used in the response. Optional. The default is the time zone of the calendar. |
public
|
#
listEvents( string $calendarId, array $optParams = array() )
Returns events on the specified calendar. (events.listEvents) Returns events on the specified calendar. (events.listEvents) Parameters
ReturnsOpt_param
bool alwaysIncludeEmail Deprecated and ignored. A value will always be returned
in the email field for the organizer, creator and attendees, even if no real
email address is available (i.e. a generated, non- working value will be
provided).
string iCalUID Specifies event ID in the iCalendar format to be included in the response. Optional. 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. int maxResults Maximum number of events returned on one result page. The number of events in the resulting page may be less than this value, or none at all, even if there are more events matching the query. Incomplete pages can be detected by a non-empty nextPageToken field in the response. By default the value is 250 events. The page size can never be larger than 2500 events. Optional. string orderBy The order of the events returned in the result. Optional. The default is an unspecified, stable order. string pageToken Token specifying which result page to return. Optional. 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. string q Free text search terms to find events that match these terms in any field, except for extended properties. Optional. 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. 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. bool showHiddenInvitations Whether to include hidden invitations in the result. Optional. The default is False. 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. 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. 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, for example, 2011-06-03T10:00:00-07:00, 2011-06-03T10:00:00Z. Milliseconds may be provided but are ignored. If timeMin is set, timeMax must be greater than timeMin. string timeMin Lower bound (exclusive) 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, for example, 2011-06-03T10:00:00-07:00, 2011-06-03T10:00:00Z. Milliseconds may be provided but are ignored. If timeMax is set, timeMin must be smaller than timeMax. string timeZone Time zone used in the response. Optional. The default is the time zone of the calendar. 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. |
public
|
#
move( string $calendarId, string $eventId, string $destination, array $optParams = array() )
Moves an event to another calendar, i.e. changes an event's organizer. (events.move) Moves an event to another calendar, i.e. changes an event's organizer. (events.move) Parameters
ReturnsOpt_param
bool sendNotifications Deprecated. Please use sendUpdates instead. Whether to
send notifications about the change of the event's organizer. Note that some
emails might still be sent even if you set the value to false. The default is
false.
string sendUpdates Guests who should receive notifications about the change of the event's organizer. |
public
|
#
patch( string $calendarId, string $eventId,
Updates an event. This method supports patch semantics. (events.patch) Updates an event. This method supports patch semantics. (events.patch) Parameters
ReturnsOpt_param
bool alwaysIncludeEmail Deprecated and ignored. A value will always be returned
in the email field for the organizer, creator and attendees, even if no real
email address is available (i.e. a generated, non- working value will be
provided).
int conferenceDataVersion Version number of conference data supported by the API client. Version 0 assumes no conference data support and ignores conference data in the event's body. Version 1 enables support for copying of ConferenceData as well as for creating new conferences using the createRequest field of conferenceData. The default is 0. 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. bool sendNotifications Deprecated. Please use sendUpdates instead. Whether to send notifications about the event update (for example, description changes, etc.). Note that some emails might still be sent even if you set the value to false. The default is false. string sendUpdates Guests who should receive notifications about the event update (for example, title changes, etc.). bool supportsAttachments Whether API client performing operation supports event attachments. Optional. The default is False. |
public
|
#
quickAdd( string $calendarId, string $text, array $optParams = array() )
Creates an event based on a simple text string. (events.quickAdd) Creates an event based on a simple text string. (events.quickAdd) Parameters
ReturnsOpt_param
bool sendNotifications Deprecated. Please use sendUpdates instead. Whether to
send notifications about the creation of the event. Note that some emails might
still be sent even if you set the value to false. The default is false.
string sendUpdates Guests who should receive notifications about the creation of the new event. |
public
|
#
update( string $calendarId, string $eventId,
Updates an event. (events.update) Updates an event. (events.update) Parameters
ReturnsOpt_param
bool alwaysIncludeEmail Deprecated and ignored. A value will always be returned
in the email field for the organizer, creator and attendees, even if no real
email address is available (i.e. a generated, non- working value will be
provided).
int conferenceDataVersion Version number of conference data supported by the API client. Version 0 assumes no conference data support and ignores conference data in the event's body. Version 1 enables support for copying of ConferenceData as well as for creating new conferences using the createRequest field of conferenceData. The default is 0. 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. bool sendNotifications Deprecated. Please use sendUpdates instead. Whether to send notifications about the event update (for example, description changes, etc.). Note that some emails might still be sent even if you set the value to false. The default is false. string sendUpdates Guests who should receive notifications about the event update (for example, title changes, etc.). bool supportsAttachments Whether API client performing operation supports event attachments. Optional. The default is False. |
public
|
#
watch( string $calendarId,
Watch for changes to Events resources. (events.watch) Watch for changes to Events resources. (events.watch) Parameters
ReturnsOpt_param
bool alwaysIncludeEmail Deprecated and ignored. A value will always be returned
in the email field for the organizer, creator and attendees, even if no real
email address is available (i.e. a generated, non- working value will be
provided).
string iCalUID Specifies event ID in the iCalendar format to be included in the response. Optional. 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. int maxResults Maximum number of events returned on one result page. The number of events in the resulting page may be less than this value, or none at all, even if there are more events matching the query. Incomplete pages can be detected by a non-empty nextPageToken field in the response. By default the value is 250 events. The page size can never be larger than 2500 events. Optional. string orderBy The order of the events returned in the result. Optional. The default is an unspecified, stable order. string pageToken Token specifying which result page to return. Optional. 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. string q Free text search terms to find events that match these terms in any field, except for extended properties. Optional. 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. 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. bool showHiddenInvitations Whether to include hidden invitations in the result. Optional. The default is False. 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. 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. 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, for example, 2011-06-03T10:00:00-07:00, 2011-06-03T10:00:00Z. Milliseconds may be provided but are ignored. If timeMin is set, timeMax must be greater than timeMin. string timeMin Lower bound (exclusive) 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, for example, 2011-06-03T10:00:00-07:00, 2011-06-03T10:00:00Z. Milliseconds may be provided but are ignored. If timeMax is set, timeMin must be smaller than timeMax. string timeZone Time zone used in the response. Optional. The default is the time zone of the calendar. 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. |