com.google.api.services.calendar

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

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

All Implemented Interfaces:

Cloneable, Map<String,Object>

Enclosing class:

Calendar.Acl

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

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.Acl.List(String calendarId) Returns the rules in the access control list for the calendar.

Method Summary

Methods

Modifier and Type	Method and Description
HttpRequest	buildHttpRequestUsingHead()
HttpResponse	executeUsingHead()
String	getCalendarId() Calendar identifier.
Integer	getMaxResults() Maximum number of entries returned on one result page.
String	getPageToken() Token specifying which result page to return.
Boolean	getShowDeleted() Whether to include deleted ACLs in the result.
String	getSyncToken() Token obtained from the nextSyncToken field returned on the last page of results from the previous list request.
Calendar.Acl.List	set(String parameterName, Object value)
Calendar.Acl.List	setAlt(String alt) Data format for the response.
Calendar.Acl.List	setCalendarId(String calendarId) Calendar identifier.
Calendar.Acl.List	setFields(String fields) Selector specifying which fields to include in a partial response.
Calendar.Acl.List	setKey(String key) API key.
Calendar.Acl.List	setMaxResults(Integer maxResults) Maximum number of entries returned on one result page.
Calendar.Acl.List	setOauthToken(String oauthToken) OAuth 2.0 token for the current user.
Calendar.Acl.List	setPageToken(String pageToken) Token specifying which result page to return.
Calendar.Acl.List	setPrettyPrint(Boolean prettyPrint) Returns response with indentations and line breaks.
Calendar.Acl.List	setQuotaUser(String quotaUser) Available to use for quota purposes for server-side applications.
Calendar.Acl.List	setShowDeleted(Boolean showDeleted) Whether to include deleted ACLs in the result.
Calendar.Acl.List	setSyncToken(String syncToken) Token obtained from the nextSyncToken field returned on the last page of results from the previous list request.
Calendar.Acl.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.Acl.List

protected Calendar.Acl.List(String calendarId)

Returns the rules in the access control list for the calendar. Create a request for the method "acl.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<Acl>

Throws:

IOException

buildHttpRequestUsingHead

public HttpRequest buildHttpRequestUsingHead()
                                      throws IOException

Overrides:

buildHttpRequestUsingHead in class AbstractGoogleClientRequest<Acl>

Throws:

IOException

setAlt

public Calendar.Acl.List setAlt(String alt)

Description copied from class: CalendarRequest

Data format for the response.

Overrides:

setAlt in class CalendarRequest<Acl>

setFields

public Calendar.Acl.List setFields(String fields)

Description copied from class: CalendarRequest

Selector specifying which fields to include in a partial response.

Overrides:

setFields in class CalendarRequest<Acl>

setKey

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

setOauthToken

public Calendar.Acl.List setOauthToken(String oauthToken)

Description copied from class: CalendarRequest

OAuth 2.0 token for the current user.

Overrides:

setOauthToken in class CalendarRequest<Acl>

setPrettyPrint

public Calendar.Acl.List setPrettyPrint(Boolean prettyPrint)

Description copied from class: CalendarRequest

Returns response with indentations and line breaks.

Overrides:

setPrettyPrint in class CalendarRequest<Acl>

setQuotaUser

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

setUserIp

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

getCalendarId

public String getCalendarId()

Calendar identifier.

setCalendarId

public Calendar.Acl.List setCalendarId(String calendarId)

Calendar identifier.

getPageToken

public String getPageToken()

Token specifying which result page to return. Optional.

setPageToken

public Calendar.Acl.List setPageToken(String pageToken)

Token specifying which result page to return. Optional.

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. All entries deleted since the previous list request will always be in the result set and it is not allowed to set showDeleted to False. 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.Acl.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. All entries deleted since the previous list request will always be in the result set and it is not allowed to set showDeleted to False. 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.

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

getShowDeleted

public Boolean getShowDeleted()

Whether to include deleted ACLs in the result. Deleted ACLs are represented by role equal to "none". Deleted ACLs will always be included if syncToken is provided. Optional. The default is False.

setShowDeleted

public Calendar.Acl.List setShowDeleted(Boolean showDeleted)

Whether to include deleted ACLs in the result. Deleted ACLs are represented by role equal to "none". Deleted ACLs will always be included if syncToken is provided. Optional. The default is False.

set

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

Overrides:

set in class CalendarRequest<Acl>