Gmail.Users.History.List (Gmail API v1 (Rev. 110) 1.25.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.gmail.GmailRequest<ListHistoryResponse>
        
        com.google.api.services.gmail.Gmail.Users.History.List

All Implemented Interfaces:

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

Enclosing class:

Gmail.Users.History
```
public class Gmail.Users.History.List
extends GmailRequest<ListHistoryResponse>
```

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 List(java.lang.String userId)
Lists the history of all changes to the given mailbox.

Constructors
Modifier	Constructor and Description
`protected`	`List(java.lang.String userId)` Lists the history of all changes to the given mailbox.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`com.google.api.client.http.HttpRequest`	`buildHttpRequestUsingHead()`
`com.google.api.client.http.HttpResponse`	`executeUsingHead()`
`java.util.List<java.lang.String>`	`getHistoryTypes()` History types to be returned by the function
`java.lang.String`	`getLabelId()` Only return messages with a label matching the ID.
`java.lang.Long`	`getMaxResults()` The maximum number of history records to return.
`java.lang.String`	`getPageToken()` Page token to retrieve a specific page of results in the list.
`java.math.BigInteger`	`getStartHistoryId()` Required.
`java.lang.String`	`getUserId()` The user's email address.
`Gmail.Users.History.List`	`set(java.lang.String parameterName, java.lang.Object value)`
`Gmail.Users.History.List`	`setAlt(java.lang.String alt)` Data format for the response.
`Gmail.Users.History.List`	`setFields(java.lang.String fields)` Selector specifying which fields to include in a partial response.
`Gmail.Users.History.List`	`setHistoryTypes(java.util.List<java.lang.String> historyTypes)` History types to be returned by the function
`Gmail.Users.History.List`	`setKey(java.lang.String key)` API key.
`Gmail.Users.History.List`	`setLabelId(java.lang.String labelId)` Only return messages with a label matching the ID.
`Gmail.Users.History.List`	`setMaxResults(java.lang.Long maxResults)` The maximum number of history records to return.
`Gmail.Users.History.List`	`setOauthToken(java.lang.String oauthToken)` OAuth 2.0 token for the current user.
`Gmail.Users.History.List`	`setPageToken(java.lang.String pageToken)` Page token to retrieve a specific page of results in the list.
`Gmail.Users.History.List`	`setPrettyPrint(java.lang.Boolean prettyPrint)` Returns response with indentations and line breaks.
`Gmail.Users.History.List`	`setQuotaUser(java.lang.String quotaUser)` An opaque string that represents a user for quota purposes.
`Gmail.Users.History.List`	`setStartHistoryId(java.math.BigInteger startHistoryId)` Required.
`Gmail.Users.History.List`	`setUserId(java.lang.String userId)` The user's email address.
`Gmail.Users.History.List`	`setUserIp(java.lang.String userIp)` Deprecated.

Methods inherited from class com.google.api.services.gmail.GmailRequest
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

Methods inherited from interface java.util.Map
compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

- Constructor Detail
  - List
```
protected List(java.lang.String userId)
```
    Lists the history of all changes to the given mailbox. History results are returned in chronological order (increasing historyId). Create a request for the method "history.list". This request holds the parameters needed by the the gmail server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.
    Gmail.initialize(com.google.api.client.googleapis.services.AbstractGoogleClientRequest) must be called to initialize this instance immediately after invoking the constructor.
    
    Parameters:
    
    userId - The user's email address. The special value me can be used to indicate the authenticated user. [default: me]
    
    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<ListHistoryResponse>
    
    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<ListHistoryResponse>
    
    Throws:
    
    java.io.IOException
  - setAlt
```
public Gmail.Users.History.List setAlt(java.lang.String alt)
```
    Description copied from class: GmailRequest
    
    Data format for the response.
    
    Overrides:
    
    setAlt in class GmailRequest<ListHistoryResponse>
  - setFields
```
public Gmail.Users.History.List setFields(java.lang.String fields)
```
    Description copied from class: GmailRequest
    
    Selector specifying which fields to include in a partial response.
    
    Overrides:
    
    setFields in class GmailRequest<ListHistoryResponse>
  - setKey
```
public Gmail.Users.History.List setKey(java.lang.String key)
```
    Description copied from class: GmailRequest
    
    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 GmailRequest<ListHistoryResponse>
  - setOauthToken
```
public Gmail.Users.History.List setOauthToken(java.lang.String oauthToken)
```
    Description copied from class: GmailRequest
    
    OAuth 2.0 token for the current user.
    
    Overrides:
    
    setOauthToken in class GmailRequest<ListHistoryResponse>
  - setPrettyPrint
```
public Gmail.Users.History.List setPrettyPrint(java.lang.Boolean prettyPrint)
```
    Description copied from class: GmailRequest
    
    Returns response with indentations and line breaks.
    
    Overrides:
    
    setPrettyPrint in class GmailRequest<ListHistoryResponse>
  - setQuotaUser
```
public Gmail.Users.History.List setQuotaUser(java.lang.String quotaUser)
```
    Description copied from class: GmailRequest
    
    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    
    Overrides:
    
    setQuotaUser in class GmailRequest<ListHistoryResponse>
  - setUserIp
```
public Gmail.Users.History.List setUserIp(java.lang.String userIp)
```
    Description copied from class: GmailRequest
    
    Deprecated. Please use quotaUser instead.
    
    Overrides:
    
    setUserIp in class GmailRequest<ListHistoryResponse>
  - getUserId
```
public java.lang.String getUserId()
```
    The user's email address. The special value me can be used to indicate the authenticated user. [default: me]
  - setUserId
```
public Gmail.Users.History.List setUserId(java.lang.String userId)
```
    The user's email address. The special value me can be used to indicate the authenticated user.
  - getHistoryTypes
```
public java.util.List<java.lang.String> getHistoryTypes()
```
    History types to be returned by the function
  - setHistoryTypes
```
public Gmail.Users.History.List setHistoryTypes(java.util.List<java.lang.String> historyTypes)
```
    History types to be returned by the function
  - getLabelId
```
public java.lang.String getLabelId()
```
    Only return messages with a label matching the ID.
  - setLabelId
```
public Gmail.Users.History.List setLabelId(java.lang.String labelId)
```
    Only return messages with a label matching the ID.
  - getMaxResults
```
public java.lang.Long getMaxResults()
```
    The maximum number of history records to return. [default: 100]
  - setMaxResults
```
public Gmail.Users.History.List setMaxResults(java.lang.Long maxResults)
```
    The maximum number of history records to return.
  - getPageToken
```
public java.lang.String getPageToken()
```
    Page token to retrieve a specific page of results in the list.
  - setPageToken
```
public Gmail.Users.History.List setPageToken(java.lang.String pageToken)
```
    Page token to retrieve a specific page of results in the list.
  - getStartHistoryId
```
public java.math.BigInteger getStartHistoryId()
```
    Required. Returns history records after the specified startHistoryId. The supplied startHistoryId should be obtained from the historyId of a message, thread, or previous list response. History IDs increase chronologically but are not contiguous with random gaps in between valid IDs. Supplying an invalid or out of date startHistoryId typically returns an HTTP 404 error code. A historyId is typically valid for at least a week, but in some rare circumstances may be valid for only a few hours. If you receive an HTTP 404 error response, your application should perform a full sync. If you receive no nextPageToken in the response, there are no updates to retrieve and you can store the returned historyId for a future request.
  - setStartHistoryId
```
public Gmail.Users.History.List setStartHistoryId(java.math.BigInteger startHistoryId)
```
    Required. Returns history records after the specified startHistoryId. The supplied startHistoryId should be obtained from the historyId of a message, thread, or previous list response. History IDs increase chronologically but are not contiguous with random gaps in between valid IDs. Supplying an invalid or out of date startHistoryId typically returns an HTTP 404 error code. A historyId is typically valid for at least a week, but in some rare circumstances may be valid for only a few hours. If you receive an HTTP 404 error response, your application should perform a full sync. If you receive no nextPageToken in the response, there are no updates to retrieve and you can store the returned historyId for a future request.
  - set
```
public Gmail.Users.History.List set(java.lang.String parameterName,
                                    java.lang.Object value)
```
    Overrides:
    
    set in class GmailRequest<ListHistoryResponse>

Gmail API v1 (revision 110)

Class Gmail.Users.History.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.gmail.GmailRequest

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

Methods inherited from interface java.util.Map

Constructor Detail

List

Method Detail

executeUsingHead

buildHttpRequestUsingHead

setAlt

setFields

setKey

setOauthToken

setPrettyPrint

setQuotaUser

setUserIp

getUserId

setUserId

getHistoryTypes

setHistoryTypes

getLabelId

setLabelId

getMaxResults

setMaxResults

getPageToken

setPageToken

getStartHistoryId

setStartHistoryId

set