com.google.api.services.calendar

Class Calendar.Events.Watch

java.lang.Object

java.util.AbstractMap<java.lang.String,java.lang.Object>

com.google.api.client.util.GenericData

com.google.api.client.googleapis.services.AbstractGoogleClientRequest<T>

com.google.api.client.googleapis.services.json.AbstractGoogleJsonClientRequest<T>

com.google.api.services.calendar.CalendarRequest<Channel>

com.google.api.services.calendar.Calendar.Events.Watch

All Implemented Interfaces:

java.lang.Cloneable, java.util.Map<java.lang.String,java.lang.Object>

Enclosing class:

Calendar.Events

public class Calendar.Events.Watch
extends CalendarRequest<Channel>

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

com.google.api.client.util.GenericData.Flags

Nested classes/interfaces inherited from class java.util.AbstractMap

java.util.AbstractMap.SimpleEntry<K,V>, java.util.AbstractMap.SimpleImmutableEntry<K,V>

Nested classes/interfaces inherited from interface java.util.Map

java.util.Map.Entry<K,V>

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Calendar.Events.Watch(java.lang.String calendarId, Channel content) Watch for changes to Events resources.

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.Boolean	getAlwaysIncludeEmail() 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.
java.lang.String	getCalendarId() Calendar identifier.
java.lang.String	getICalUID() Specifies event ID in the iCalendar format to be included in the response.
java.lang.Integer	getMaxAttendees() The maximum number of attendees to include in the response.
java.lang.Integer	getMaxResults() Maximum number of events returned on one result page.
java.lang.String	getOrderBy() The order of the events returned in the result.
java.lang.String	getPageToken() Token specifying which result page to return.
java.util.List<java.lang.String>	getPrivateExtendedProperty() Extended properties constraint specified as propertyName=value.
java.lang.String	getQ() Free text search terms to find events that match these terms in any field, except for extended properties.
java.util.List<java.lang.String>	getSharedExtendedProperty() Extended properties constraint specified as propertyName=value.
java.lang.Boolean	getShowDeleted() Whether to include deleted events (with status equals "cancelled") in the result.
java.lang.Boolean	getShowHiddenInvitations() Whether to include hidden invitations in the result.
java.lang.Boolean	getSingleEvents() 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.
java.lang.String	getSyncToken() Token obtained from the nextSyncToken field returned on the last page of results from the previous list request.
com.google.api.client.util.DateTime	getTimeMax() Upper bound (exclusive) for an event's start time to filter by.
com.google.api.client.util.DateTime	getTimeMin() Lower bound (inclusive) for an event's end time to filter by.
java.lang.String	getTimeZone() Time zone used in the response.
com.google.api.client.util.DateTime	getUpdatedMin() Lower bound for an event's last modification time (as a RFC 3339 timestamp) to filter by.
Calendar.Events.Watch	set(java.lang.String parameterName, java.lang.Object value)
Calendar.Events.Watch	setAlt(java.lang.String alt) Data format for the response.
Calendar.Events.Watch	setAlwaysIncludeEmail(java.lang.Boolean 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.
Calendar.Events.Watch	setCalendarId(java.lang.String calendarId) Calendar identifier.
Calendar.Events.Watch	setFields(java.lang.String fields) Selector specifying which fields to include in a partial response.
Calendar.Events.Watch	setICalUID(java.lang.String iCalUID) Specifies event ID in the iCalendar format to be included in the response.
Calendar.Events.Watch	setKey(java.lang.String key) API key.
Calendar.Events.Watch	setMaxAttendees(java.lang.Integer maxAttendees) The maximum number of attendees to include in the response.
Calendar.Events.Watch	setMaxResults(java.lang.Integer maxResults) Maximum number of events returned on one result page.
Calendar.Events.Watch	setOauthToken(java.lang.String oauthToken) OAuth 2.0 token for the current user.
Calendar.Events.Watch	setOrderBy(java.lang.String orderBy) The order of the events returned in the result.
Calendar.Events.Watch	setPageToken(java.lang.String pageToken) Token specifying which result page to return.
Calendar.Events.Watch	setPrettyPrint(java.lang.Boolean prettyPrint) Returns response with indentations and line breaks.
Calendar.Events.Watch	setPrivateExtendedProperty(java.util.List<java.lang.String> privateExtendedProperty) Extended properties constraint specified as propertyName=value.
Calendar.Events.Watch	setQ(java.lang.String q) Free text search terms to find events that match these terms in any field, except for extended properties.
Calendar.Events.Watch	setQuotaUser(java.lang.String quotaUser) Available to use for quota purposes for server-side applications.
Calendar.Events.Watch	setSharedExtendedProperty(java.util.List<java.lang.String> sharedExtendedProperty) Extended properties constraint specified as propertyName=value.
Calendar.Events.Watch	setShowDeleted(java.lang.Boolean showDeleted) Whether to include deleted events (with status equals "cancelled") in the result.
Calendar.Events.Watch	setShowHiddenInvitations(java.lang.Boolean showHiddenInvitations) Whether to include hidden invitations in the result.
Calendar.Events.Watch	setSingleEvents(java.lang.Boolean 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.
Calendar.Events.Watch	setSyncToken(java.lang.String syncToken) Token obtained from the nextSyncToken field returned on the last page of results from the previous list request.
Calendar.Events.Watch	setTimeMax(com.google.api.client.util.DateTime timeMax) Upper bound (exclusive) for an event's start time to filter by.
Calendar.Events.Watch	setTimeMin(com.google.api.client.util.DateTime timeMin) Lower bound (inclusive) for an event's end time to filter by.
Calendar.Events.Watch	setTimeZone(java.lang.String timeZone) Time zone used in the response.
Calendar.Events.Watch	setUpdatedMin(com.google.api.client.util.DateTime updatedMin) Lower bound for an event's last modification time (as a RFC 3339 timestamp) to filter by.
Calendar.Events.Watch	setUserIp(java.lang.String userIp) IP address of the site where the request originates.

Methods inherited from class com.google.api.services.calendar.CalendarRequest

getAbstractGoogleClient, getAlt, getFields, getKey, getOauthToken, getPrettyPrint, getQuotaUser, getUserIp, setDisableGZipContent, setRequestHeaders

Methods inherited from class com.google.api.client.googleapis.services.json.AbstractGoogleJsonClientRequest

getJsonContent, newExceptionOnError, queue

Methods inherited from class com.google.api.client.googleapis.services.AbstractGoogleClientRequest

buildHttpRequest, buildHttpRequestUrl, buildHttpRequestUsingHead, checkRequiredParameter, execute, executeAndDownloadTo, executeAsInputStream, executeMedia, executeMediaAndDownloadTo, executeMediaAsInputStream, executeUnparsed, executeUsingHead, getDisableGZipContent, getHttpContent, getLastResponseHeaders, getLastStatusCode, getLastStatusMessage, getMediaHttpDownloader, getMediaHttpUploader, getRequestHeaders, getRequestMethod, getResponseClass, getUriTemplate, initializeMediaDownload, initializeMediaUpload, queue

Methods inherited from class com.google.api.client.util.GenericData

clone, entrySet, get, getClassInfo, getUnknownKeys, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap

clear, containsKey, containsValue, equals, hashCode, isEmpty, keySet, size, toString, values

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Calendar.Events.Watch

protected Calendar.Events.Watch(java.lang.String calendarId,
                     Channel content)

Watch for changes to Events resources. Create a request for the method "events.watch". This request holds the parameters needed by the the calendar server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Calendar.initialize(com.google.api.client.googleapis.services.AbstractGoogleClientRequest) must be called to initialize this instance immediately after invoking the constructor.

Parameters:

calendarId - Calendar identifier.

content - the Channel

Since:

1.13

Method Detail

setAlt

public Calendar.Events.Watch setAlt(java.lang.String alt)

Description copied from class: CalendarRequest

Data format for the response.

Overrides:

setAlt in class CalendarRequest<Channel>

setFields

public Calendar.Events.Watch setFields(java.lang.String fields)

Description copied from class: CalendarRequest

Selector specifying which fields to include in a partial response.

Overrides:

setFields in class CalendarRequest<Channel>

setKey

public Calendar.Events.Watch setKey(java.lang.String key)

Description copied from class: CalendarRequest

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Overrides:

setKey in class CalendarRequest<Channel>

setOauthToken

public Calendar.Events.Watch setOauthToken(java.lang.String oauthToken)

Description copied from class: CalendarRequest

OAuth 2.0 token for the current user.

Overrides:

setOauthToken in class CalendarRequest<Channel>

setPrettyPrint

public Calendar.Events.Watch setPrettyPrint(java.lang.Boolean prettyPrint)

Description copied from class: CalendarRequest

Returns response with indentations and line breaks.

Overrides:

setPrettyPrint in class CalendarRequest<Channel>

setQuotaUser

public Calendar.Events.Watch setQuotaUser(java.lang.String quotaUser)

Description copied from class: CalendarRequest

Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.

Overrides:

setQuotaUser in class CalendarRequest<Channel>

setUserIp

public Calendar.Events.Watch setUserIp(java.lang.String userIp)

Description copied from class: CalendarRequest

IP address of the site where the request originates. Use this if you want to enforce per-user limits.

Overrides:

setUserIp in class CalendarRequest<Channel>

getCalendarId

public java.lang.String getCalendarId()

Calendar identifier.

setCalendarId

public Calendar.Events.Watch setCalendarId(java.lang.String calendarId)

Calendar identifier.

getOrderBy

public java.lang.String getOrderBy()

The order of the events returned in the result. Optional. The default is an unspecified, stable order.

setOrderBy

public Calendar.Events.Watch setOrderBy(java.lang.String orderBy)

The order of the events returned in the result. Optional. The default is an unspecified, stable order.

getShowHiddenInvitations

public java.lang.Boolean getShowHiddenInvitations()

Whether to include hidden invitations in the result. Optional. The default is False.

setShowHiddenInvitations

public Calendar.Events.Watch setShowHiddenInvitations(java.lang.Boolean showHiddenInvitations)

Whether to include hidden invitations in the result. Optional. The default is False.

getSyncToken

public java.lang.String getSyncToken()

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.

setSyncToken

public Calendar.Events.Watch setSyncToken(java.lang.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.

getShowDeleted

public java.lang.Boolean getShowDeleted()

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.

setShowDeleted

public Calendar.Events.Watch setShowDeleted(java.lang.Boolean 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.

getICalUID

public java.lang.String getICalUID()

Specifies event ID in the iCalendar format to be included in the response. Optional.

setICalUID

public Calendar.Events.Watch setICalUID(java.lang.String iCalUID)

Specifies event ID in the iCalendar format to be included in the response. Optional.

getUpdatedMin

public com.google.api.client.util.DateTime getUpdatedMin()

Lower bound for an event's last modification time (as a RFC 3339 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.

setUpdatedMin

public Calendar.Events.Watch setUpdatedMin(com.google.api.client.util.DateTime updatedMin)

Lower bound for an event's last modification time (as a RFC 3339 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.

getSingleEvents

public java.lang.Boolean getSingleEvents()

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.

setSingleEvents

public Calendar.Events.Watch setSingleEvents(java.lang.Boolean 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.

getTimeMax

public com.google.api.client.util.DateTime getTimeMax()

Upper bound (exclusive) for an event's start time to filter by. Optional. The default is not to filter by start time.

setTimeMax

public Calendar.Events.Watch setTimeMax(com.google.api.client.util.DateTime timeMax)

Upper bound (exclusive) for an event's start time to filter by. Optional. The default is not to filter by start time.

getAlwaysIncludeEmail

public java.lang.Boolean getAlwaysIncludeEmail()

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.

setAlwaysIncludeEmail

public Calendar.Events.Watch setAlwaysIncludeEmail(java.lang.Boolean 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.

getMaxResults

public java.lang.Integer getMaxResults()

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. [minimum: 1]

setMaxResults

public Calendar.Events.Watch setMaxResults(java.lang.Integer 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.

getQ

public java.lang.String getQ()

Free text search terms to find events that match these terms in any field, except for extended properties. Optional.

setQ

public Calendar.Events.Watch setQ(java.lang.String q)

Free text search terms to find events that match these terms in any field, except for extended properties. Optional.

getPageToken

public java.lang.String getPageToken()

Token specifying which result page to return. Optional.

setPageToken

public Calendar.Events.Watch setPageToken(java.lang.String pageToken)

Token specifying which result page to return. Optional.

getTimeMin

public com.google.api.client.util.DateTime getTimeMin()

Lower bound (inclusive) for an event's end time to filter by. Optional. The default is not to filter by end time.

setTimeMin

public Calendar.Events.Watch setTimeMin(com.google.api.client.util.DateTime timeMin)

Lower bound (inclusive) for an event's end time to filter by. Optional. The default is not to filter by end time.

getTimeZone

public java.lang.String getTimeZone()

Time zone used in the response. Optional. The default is the time zone of the calendar.

setTimeZone

public Calendar.Events.Watch setTimeZone(java.lang.String timeZone)

Time zone used in the response. Optional. The default is the time zone of the calendar.

getPrivateExtendedProperty

public java.util.List<java.lang.String> getPrivateExtendedProperty()

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.

setPrivateExtendedProperty

public Calendar.Events.Watch setPrivateExtendedProperty(java.util.List<java.lang.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.

getSharedExtendedProperty

public java.util.List<java.lang.String> getSharedExtendedProperty()

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.

setSharedExtendedProperty

public Calendar.Events.Watch setSharedExtendedProperty(java.util.List<java.lang.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.

getMaxAttendees

public java.lang.Integer getMaxAttendees()

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. [minimum: 1]

setMaxAttendees

public Calendar.Events.Watch setMaxAttendees(java.lang.Integer 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.

set

public Calendar.Events.Watch set(java.lang.String parameterName,
                        java.lang.Object value)

Overrides:

set in class CalendarRequest<Channel>