com.google.api.services.gmail.model

Class History

java.lang.Object

java.util.AbstractMap<java.lang.String,java.lang.Object>

com.google.api.client.util.GenericData

com.google.api.client.json.GenericJson

com.google.api.services.gmail.model.History

All Implemented Interfaces:

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

public final class History
extends com.google.api.client.json.GenericJson

A record of a change to the user's mailbox. Each history change may affect multiple messages in multiple ways.

This is the Java data model class that specifies how to parse/serialize into the JSON that is transmitted over HTTP when working with the Gmail API. For a detailed explanation see: http://code.google.com/p/google-http-java-client/wiki/JSON

Author:

Google, Inc.

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>

Constructor Summary

Constructors

Constructor and Description
History()

Method Summary

Methods

Modifier and Type	Method and Description
History	clone()
java.math.BigInteger	getId() The mailbox sequence ID.
java.util.List<HistoryLabelAdded>	getLabelsAdded() Labels added to messages in this history record.
java.util.List<HistoryLabelRemoved>	getLabelsRemoved() Labels removed from messages in this history record.
java.util.List<Message>	getMessages() List of messages changed in this history record.
java.util.List<HistoryMessageAdded>	getMessagesAdded() Messages added to the mailbox in this history record.
java.util.List<HistoryMessageDeleted>	getMessagesDeleted() Messages deleted (not Trashed) from the mailbox in this history record.
History	set(java.lang.String fieldName, java.lang.Object value)
History	setId(java.math.BigInteger id) The mailbox sequence ID.
History	setLabelsAdded(java.util.List<HistoryLabelAdded> labelsAdded) Labels added to messages in this history record.
History	setLabelsRemoved(java.util.List<HistoryLabelRemoved> labelsRemoved) Labels removed from messages in this history record.
History	setMessages(java.util.List<Message> messages) List of messages changed in this history record.
History	setMessagesAdded(java.util.List<HistoryMessageAdded> messagesAdded) Messages added to the mailbox in this history record.
History	setMessagesDeleted(java.util.List<HistoryMessageDeleted> messagesDeleted) Messages deleted (not Trashed) from the mailbox in this history record.

Methods inherited from class com.google.api.client.json.GenericJson

getFactory, setFactory, toPrettyString, toString

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

entrySet, get, getClassInfo, getUnknownKeys, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap

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

Methods inherited from class java.lang.Object

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

Constructor Detail

History

public History()

Method Detail

getId

public java.math.BigInteger getId()

The mailbox sequence ID.

Returns:

value or null for none

setId

public History setId(java.math.BigInteger id)

The mailbox sequence ID.

Parameters:

id - id or null for none

getLabelsAdded

public java.util.List<HistoryLabelAdded> getLabelsAdded()

Labels added to messages in this history record.

Returns:

value or null for none

setLabelsAdded

public History setLabelsAdded(java.util.List<HistoryLabelAdded> labelsAdded)

Labels added to messages in this history record.

Parameters:

labelsAdded - labelsAdded or null for none

getLabelsRemoved

public java.util.List<HistoryLabelRemoved> getLabelsRemoved()

Labels removed from messages in this history record.

Returns:

value or null for none

setLabelsRemoved

public History setLabelsRemoved(java.util.List<HistoryLabelRemoved> labelsRemoved)

Labels removed from messages in this history record.

Parameters:

labelsRemoved - labelsRemoved or null for none

getMessages

public java.util.List<Message> getMessages()

List of messages changed in this history record. The fields for specific change types, such as messagesAdded may duplicate messages in this field. We recommend using the specific change-type fields instead of this.

Returns:

value or null for none

setMessages

public History setMessages(java.util.List<Message> messages)

List of messages changed in this history record. The fields for specific change types, such as messagesAdded may duplicate messages in this field. We recommend using the specific change-type fields instead of this.

Parameters:

messages - messages or null for none

getMessagesAdded

public java.util.List<HistoryMessageAdded> getMessagesAdded()

Messages added to the mailbox in this history record.

Returns:

value or null for none

setMessagesAdded

public History setMessagesAdded(java.util.List<HistoryMessageAdded> messagesAdded)

Messages added to the mailbox in this history record.

Parameters:

messagesAdded - messagesAdded or null for none

getMessagesDeleted

public java.util.List<HistoryMessageDeleted> getMessagesDeleted()

Messages deleted (not Trashed) from the mailbox in this history record.

Returns:

value or null for none

setMessagesDeleted

public History setMessagesDeleted(java.util.List<HistoryMessageDeleted> messagesDeleted)

Messages deleted (not Trashed) from the mailbox in this history record.

Parameters:

messagesDeleted - messagesDeleted or null for none

set

public History set(java.lang.String fieldName,
          java.lang.Object value)

Overrides:

set in class com.google.api.client.json.GenericJson

clone

public History clone()

Overrides:

clone in class com.google.api.client.json.GenericJson