com.google.api.services.calendar

Class Calendar.Events.List

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<Events>

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

All Implemented Interfaces:

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

Enclosing class:

Calendar.Events

public class Calendar.Events.List
extends CalendarRequest<Events>

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>

Field Summary

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

USER_AGENT_SUFFIX

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Calendar.Events.List(java.lang.String calendarId) Returns events on the specified calendar.

Method Summary

Methods

Modifier and Type	Method and Description
com.google.api.client.http.HttpRequest	buildHttpRequestUsingHead()
com.google.api.client.http.HttpResponse	executeUsingHead()
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 RFC3339 timestamp) to filter by.
Calendar.Events.List	set(java.lang.String parameterName, java.lang.Object value)
Calendar.Events.List	setAlt(java.lang.String alt) Data format for the response.
Calendar.Events.List	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.List	setCalendarId(java.lang.String calendarId) Calendar identifier.
Calendar.Events.List	setFields(java.lang.String fields) Selector specifying which fields to include in a partial response.
Calendar.Events.List	setICalUID(java.lang.String iCalUID) Specifies event ID in the iCalendar format to be included in the response.
Calendar.Events.List	setKey(java.lang.String key) API key.
Calendar.Events.List	setMaxAttendees(java.lang.Integer maxAttendees) The maximum number of attendees to include in the response.
Calendar.Events.List	setMaxResults(java.lang.Integer maxResults) Maximum number of events returned on one result page.
Calendar.Events.List	setOauthToken(java.lang.String oauthToken) OAuth 2.0 token for the current user.
Calendar.Events.List	setOrderBy(java.lang.String orderBy) The order of the events returned in the result.
Calendar.Events.List	setPageToken(java.lang.String pageToken) Token specifying which result page to return.
Calendar.Events.List	setPrettyPrint(java.lang.Boolean prettyPrint) Returns response with indentations and line breaks.
Calendar.Events.List	setPrivateExtendedProperty(java.util.List<java.lang.String> privateExtendedProperty) Extended properties constraint specified as propertyName=value.
Calendar.Events.List	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.List	setQuotaUser(java.lang.String quotaUser) Available to use for quota purposes for server-side applications.
Calendar.Events.List	setSharedExtendedProperty(java.util.List<java.lang.String> sharedExtendedProperty) Extended properties constraint specified as propertyName=value.
Calendar.Events.List	setShowDeleted(java.lang.Boolean showDeleted) Whether to include deleted events (with status equals "cancelled") in the result.
Calendar.Events.List	setShowHiddenInvitations(java.lang.Boolean showHiddenInvitations) Whether to include hidden invitations in the result.
Calendar.Events.List	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.List	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.List	setTimeMax(com.google.api.client.util.DateTime timeMax) Upper bound (exclusive) for an event's start time to filter by.
Calendar.Events.List	setTimeMin(com.google.api.client.util.DateTime timeMin) Lower bound (inclusive) for an event's end time to filter by.
Calendar.Events.List	setTimeZone(java.lang.String timeZone) Time zone used in the response.
Calendar.Events.List	setUpdatedMin(com.google.api.client.util.DateTime updatedMin) Lower bound for an event's last modification time (as a RFC3339 timestamp) to filter by.
Calendar.Events.List	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, checkRequiredParameter, execute, executeAndDownloadTo, executeAsInputStream, executeMedia, executeMediaAndDownloadTo, executeMediaAsInputStream, executeUnparsed, 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.List

protected Calendar.Events.List(java.lang.String calendarId)

Returns events on the specified calendar. Create a request for the method "events.list". 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. 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.

Since:

1.13

Method Detail

executeUsingHead

public com.google.api.client.http.HttpResponse executeUsingHead()
                                                         throws java.io.IOException

Overrides:

executeUsingHead in class com.google.api.client.googleapis.services.AbstractGoogleClientRequest<Events>

Throws:

java.io.IOException

buildHttpRequestUsingHead

public com.google.api.client.http.HttpRequest buildHttpRequestUsingHead()
                                                                 throws java.io.IOException

Overrides:

buildHttpRequestUsingHead in class com.google.api.client.googleapis.services.AbstractGoogleClientRequest<Events>

Throws:

java.io.IOException

setAlt

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

Description copied from class: CalendarRequest

Data format for the response.

Overrides:

setAlt in class CalendarRequest<Events>

setFields

public Calendar.Events.List 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<Events>

setKey

public Calendar.Events.List 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<Events>

setOauthToken

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

Description copied from class: CalendarRequest

OAuth 2.0 token for the current user.

Overrides:

setOauthToken in class CalendarRequest<Events>

setPrettyPrint

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

Description copied from class: CalendarRequest

Returns response with indentations and line breaks.

Overrides:

setPrettyPrint in class CalendarRequest<Events>

setQuotaUser

public Calendar.Events.List 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<Events>

setUserIp

public Calendar.Events.List 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<Events>

getCalendarId

public java.lang.String getCalendarId()

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.

setCalendarId

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

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.List 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.

getICalUID

public java.lang.String getICalUID()

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

setICalUID

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

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

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.List 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.

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.List 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.

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.List setOrderBy(java.lang.String orderBy)

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

getPageToken

public java.lang.String getPageToken()

Token specifying which result page to return. Optional.

setPageToken

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

Token specifying which result page to return. Optional.

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.List 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.

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.List setQ(java.lang.String q)

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

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.List 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.

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.List 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.

getShowHiddenInvitations

public java.lang.Boolean getShowHiddenInvitations()

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

setShowHiddenInvitations

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

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

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.List 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.

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.List 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.

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. 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.

setTimeMax

public Calendar.Events.List 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. 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.

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. 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.

setTimeMin

public Calendar.Events.List 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. 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.

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.List setTimeZone(java.lang.String timeZone)

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

getUpdatedMin

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

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.

setUpdatedMin

public Calendar.Events.List setUpdatedMin(com.google.api.client.util.DateTime 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.

set

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

Overrides:

set in class CalendarRequest<Events>