com.google.api.services.calendar

Class Calendar.Events.List

java.lang.Object

java.util.AbstractMap<String,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:

Cloneable, Map<String,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

GenericData.Flags

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

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

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

Map.Entry<K,V>

Constructor Summary

Constructors

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

Method Summary

Methods

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

Since:

1.13

Method Detail

executeUsingHead

public HttpResponse executeUsingHead()
                              throws IOException

Overrides:

executeUsingHead in class AbstractGoogleClientRequest<Events>

Throws:

IOException

buildHttpRequestUsingHead

public HttpRequest buildHttpRequestUsingHead()
                                      throws IOException

Overrides:

buildHttpRequestUsingHead in class AbstractGoogleClientRequest<Events>

Throws:

IOException

setAlt

public Calendar.Events.List setAlt(String alt)

Description copied from class: CalendarRequest

Data format for the response.

Overrides:

setAlt in class CalendarRequest<Events>

setFields

public Calendar.Events.List setFields(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(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(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(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(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(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 String getCalendarId()

Calendar identifier.

setCalendarId

public Calendar.Events.List setCalendarId(String calendarId)

Calendar identifier.

getOrderBy

public 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(String orderBy)

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

getShowHiddenInvitations

public Boolean getShowHiddenInvitations()

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

setShowHiddenInvitations

public Calendar.Events.List setShowHiddenInvitations(Boolean showHiddenInvitations)

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

getShowDeleted

public 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(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 String getICalUID()

Specifies iCalendar UID (iCalUID) of events to be included in the response. Optional.

setICalUID

public Calendar.Events.List setICalUID(String iCalUID)

Specifies iCalendar UID (iCalUID) of events to be included in the response. Optional.

getUpdatedMin

public DateTime getUpdatedMin()

Lower bound for an event's last modification time (as a RFC 3339 timestamp) to filter by. Optional. The default is not to filter by last modification time.

setUpdatedMin

public Calendar.Events.List setUpdatedMin(DateTime updatedMin)

Lower bound for an event's last modification time (as a RFC 3339 timestamp) to filter by. Optional. The default is not to filter by last modification time.

getSingleEvents

public 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(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 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.List setTimeMax(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 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(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 Integer getMaxResults()

Maximum number of events returned on one result page. Optional. [minimum: 1]

setMaxResults

public Calendar.Events.List setMaxResults(Integer maxResults)

Maximum number of events returned on one result page. Optional.

getQ

public 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(String q)

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

getPageToken

public String getPageToken()

Token specifying which result page to return. Optional.

setPageToken

public Calendar.Events.List setPageToken(String pageToken)

Token specifying which result page to return. Optional.

getTimeMin

public 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.List setTimeMin(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 String getTimeZone()

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

setTimeZone

public Calendar.Events.List setTimeZone(String timeZone)

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

getPrivateExtendedProperty

public List<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(List<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 List<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(List<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 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(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.List set(String parameterName,
                       Object value)

Overrides:

set in class CalendarRequest<Events>