com.google.api.services.calendar

Class Calendar.CalendarList.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<CalendarList>

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

All Implemented Interfaces:

Cloneable, Map<String,Object>

Enclosing class:

Calendar.CalendarList

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

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

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

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

Map.Entry<K,V>

Field Summary

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

API_VERSION_HEADER, USER_AGENT_SUFFIX

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	List() Returns the calendars on the user's calendar list.

Method Summary

Modifier and Type	Method and Description
com.google.api.client.http.HttpRequest	buildHttpRequestUsingHead()
com.google.api.client.http.HttpResponse	executeUsingHead()
Integer	getMaxResults() Maximum number of entries returned on one result page.
String	getMinAccessRole() The minimum access role for the user in the returned entries.
String	getPageToken() Token specifying which result page to return.
Boolean	getShowDeleted() Whether to include deleted calendar list entries in the result.
Boolean	getShowHidden() Whether to show hidden entries.
String	getSyncToken() Token obtained from the nextSyncToken field returned on the last page of results from the previous list request.
Calendar.CalendarList.List	set(String parameterName, Object value)
Calendar.CalendarList.List	setAlt(String alt) Data format for the response.
Calendar.CalendarList.List	setFields(String fields) Selector specifying which fields to include in a partial response.
Calendar.CalendarList.List	setKey(String key) API key.
Calendar.CalendarList.List	setMaxResults(Integer maxResults) Maximum number of entries returned on one result page.
Calendar.CalendarList.List	setMinAccessRole(String minAccessRole) The minimum access role for the user in the returned entries.
Calendar.CalendarList.List	setOauthToken(String oauthToken) OAuth 2.0 token for the current user.
Calendar.CalendarList.List	setPageToken(String pageToken) Token specifying which result page to return.
Calendar.CalendarList.List	setPrettyPrint(Boolean prettyPrint) Returns response with indentations and line breaks.
Calendar.CalendarList.List	setQuotaUser(String quotaUser) An opaque string that represents a user for quota purposes.
Calendar.CalendarList.List	setShowDeleted(Boolean showDeleted) Whether to include deleted calendar list entries in the result.
Calendar.CalendarList.List	setShowHidden(Boolean showHidden) Whether to show hidden entries.
Calendar.CalendarList.List	setSyncToken(String syncToken) Token obtained from the nextSyncToken field returned on the last page of results from the previous list request.
Calendar.CalendarList.List	setUserIp(String userIp) Deprecated.

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, getReturnRawInputSteam, getUriTemplate, initializeMediaDownload, initializeMediaUpload, queue, setReturnRawInputStream

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

clone, entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys, toString

Methods inherited from class java.util.AbstractMap

clear, containsKey, containsValue, isEmpty, keySet, size, values

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

Constructor Detail

List

protected List()

Returns the calendars on the user's calendar list. Create a request for the method "calendarList.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.

Since:

1.13

Method Detail

executeUsingHead

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

Overrides:

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

Throws:

IOException

buildHttpRequestUsingHead

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

Overrides:

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

Throws:

IOException

setAlt

public Calendar.CalendarList.List setAlt(String alt)

Description copied from class: CalendarRequest

Data format for the response.

Overrides:

setAlt in class CalendarRequest<CalendarList>

setFields

public Calendar.CalendarList.List setFields(String fields)

Description copied from class: CalendarRequest

Selector specifying which fields to include in a partial response.

Overrides:

setFields in class CalendarRequest<CalendarList>

setKey

public Calendar.CalendarList.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<CalendarList>

setOauthToken

public Calendar.CalendarList.List setOauthToken(String oauthToken)

Description copied from class: CalendarRequest

OAuth 2.0 token for the current user.

Overrides:

setOauthToken in class CalendarRequest<CalendarList>

setPrettyPrint

public Calendar.CalendarList.List setPrettyPrint(Boolean prettyPrint)

Description copied from class: CalendarRequest

Returns response with indentations and line breaks.

Overrides:

setPrettyPrint in class CalendarRequest<CalendarList>

setQuotaUser

public Calendar.CalendarList.List setQuotaUser(String quotaUser)

Description copied from class: CalendarRequest

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Overrides:

setQuotaUser in class CalendarRequest<CalendarList>

setUserIp

public Calendar.CalendarList.List setUserIp(String userIp)

Description copied from class: CalendarRequest

Deprecated. Please use quotaUser instead.

Overrides:

setUserIp in class CalendarRequest<CalendarList>

getMaxResults

public Integer getMaxResults()

Maximum number of entries returned on one result page. By default the value is 100 entries. The page size can never be larger than 250 entries. Optional. [minimum: 1]

setMaxResults

public Calendar.CalendarList.List setMaxResults(Integer maxResults)

Maximum number of entries returned on one result page. By default the value is 100 entries. The page size can never be larger than 250 entries. Optional.

getMinAccessRole

public String getMinAccessRole()

The minimum access role for the user in the returned entries. Optional. The default is no restriction.

setMinAccessRole

public Calendar.CalendarList.List setMinAccessRole(String minAccessRole)

The minimum access role for the user in the returned entries. Optional. The default is no restriction.

getPageToken

public String getPageToken()

Token specifying which result page to return. Optional.

setPageToken

public Calendar.CalendarList.List setPageToken(String pageToken)

Token specifying which result page to return. Optional.

getShowDeleted

public Boolean getShowDeleted()

Whether to include deleted calendar list entries in the result. Optional. The default is False.

setShowDeleted

public Calendar.CalendarList.List setShowDeleted(Boolean showDeleted)

Whether to include deleted calendar list entries in the result. Optional. The default is False.

getShowHidden

public Boolean getShowHidden()

Whether to show hidden entries. Optional. The default is False.

setShowHidden

public Calendar.CalendarList.List setShowHidden(Boolean showHidden)

Whether to show hidden entries. Optional. The default is False.

getSyncToken

public 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. If only read-only fields such as calendar properties or ACLs have changed, the entry won't be returned. All entries deleted and hidden since the previous list request will always be in the result set and it is not allowed to set showDeleted neither showHidden to False. To ensure client state consistency minAccessRole query parameter cannot be specified together with nextSyncToken. 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.CalendarList.List setSyncToken(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. If only read-only fields such as calendar properties or ACLs have changed, the entry won't be returned. All entries deleted and hidden since the previous list request will always be in the result set and it is not allowed to set showDeleted neither showHidden to False. To ensure client state consistency minAccessRole query parameter cannot be specified together with nextSyncToken. 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.

set

public Calendar.CalendarList.List set(String parameterName,
                                      Object value)

Overrides:

set in class CalendarRequest<CalendarList>