Calendar.Settings.List (Calendar API v3 (Rev. 291) 1.22.0)

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<Settings>
        
        com.google.api.services.calendar.Calendar.Settings.List

All Implemented Interfaces:

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

Enclosing class:

Calendar.Settings
```
public class Calendar.Settings.List
extends CalendarRequest<Settings>
```

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.Settings.List()
Returns all user settings for the authenticated user.

Constructors
Modifier	Constructor and Description
`protected`	`Calendar.Settings.List()` Returns all user settings for the authenticated user.

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.Integer`	`getMaxResults()` Maximum number of entries returned on one result page.
`java.lang.String`	`getPageToken()` Token specifying which result page to return.
`java.lang.String`	`getSyncToken()` Token obtained from the nextSyncToken field returned on the last page of results from the previous list request.
`Calendar.Settings.List`	`set(java.lang.String parameterName, java.lang.Object value)`
`Calendar.Settings.List`	`setAlt(java.lang.String alt)` Data format for the response.
`Calendar.Settings.List`	`setFields(java.lang.String fields)` Selector specifying which fields to include in a partial response.
`Calendar.Settings.List`	`setKey(java.lang.String key)` API key.
`Calendar.Settings.List`	`setMaxResults(java.lang.Integer maxResults)` Maximum number of entries returned on one result page.
`Calendar.Settings.List`	`setOauthToken(java.lang.String oauthToken)` OAuth 2.0 token for the current user.
`Calendar.Settings.List`	`setPageToken(java.lang.String pageToken)` Token specifying which result page to return.
`Calendar.Settings.List`	`setPrettyPrint(java.lang.Boolean prettyPrint)` Returns response with indentations and line breaks.
`Calendar.Settings.List`	`setQuotaUser(java.lang.String quotaUser)` Available to use for quota purposes for server-side applications.
`Calendar.Settings.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.Settings.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.Settings.List
```
protected Calendar.Settings.List()
```
    Returns all user settings for the authenticated user. Create a request for the method "settings.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 java.io.IOException
```
    Overrides:
    
    executeUsingHead in class com.google.api.client.googleapis.services.AbstractGoogleClientRequest<Settings>
    
    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<Settings>
    
    Throws:
    
    java.io.IOException
  - setAlt
```
public Calendar.Settings.List setAlt(java.lang.String alt)
```
    Description copied from class: CalendarRequest
    
    Data format for the response.
    
    Overrides:
    
    setAlt in class CalendarRequest<Settings>
  - setFields
```
public Calendar.Settings.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<Settings>
  - setKey
```
public Calendar.Settings.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<Settings>
  - setOauthToken
```
public Calendar.Settings.List setOauthToken(java.lang.String oauthToken)
```
    Description copied from class: CalendarRequest
    
    OAuth 2.0 token for the current user.
    
    Overrides:
    
    setOauthToken in class CalendarRequest<Settings>
  - setPrettyPrint
```
public Calendar.Settings.List setPrettyPrint(java.lang.Boolean prettyPrint)
```
    Description copied from class: CalendarRequest
    
    Returns response with indentations and line breaks.
    
    Overrides:
    
    setPrettyPrint in class CalendarRequest<Settings>
  - setQuotaUser
```
public Calendar.Settings.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<Settings>
  - setUserIp
```
public Calendar.Settings.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<Settings>
  - getMaxResults
```
public java.lang.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.Settings.List setMaxResults(java.lang.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.
  - getPageToken
```
public java.lang.String getPageToken()
```
    Token specifying which result page to return. Optional.
  - setPageToken
```
public Calendar.Settings.List setPageToken(java.lang.String pageToken)
```
    Token specifying which result page to return. Optional.
  - 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. 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.Settings.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. 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.Settings.List set(java.lang.String parameterName,
                         java.lang.Object value)
```
    Overrides:
    
    set in class CalendarRequest<Settings>

Calendar API v3 (revision 291)

Class Calendar.Settings.List

Nested Class Summary

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

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

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

Field Summary

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

Constructor Summary

Method Summary

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

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

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

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

Methods inherited from class java.util.AbstractMap

Methods inherited from class java.lang.Object

Constructor Detail

Calendar.Settings.List

Method Detail

executeUsingHead

buildHttpRequestUsingHead

setAlt

setFields

setKey

setOauthToken

setPrettyPrint

setQuotaUser

setUserIp

getMaxResults

setMaxResults

getPageToken

setPageToken

getSyncToken

setSyncToken

set