#include <history.h>

Inheritance diagram for google_gmail_api::History:

Public Member Functions
	History (const Json::Value &storage)

	History (Json::Value *storage)

virtual	~History ()

const StringPiece	GetTypeName () const

bool	has_id () const

void	clear_id ()

uint64	get_id () const

void	set_id (uint64 value)

bool	has_labels_added () const

void	clear_labels_added ()

const client::JsonCppArray< HistoryLabelAdded >	get_labels_added () const

client::JsonCppArray< HistoryLabelAdded >	mutable_labelsAdded ()

bool	has_labels_removed () const

void	clear_labels_removed ()

const client::JsonCppArray< HistoryLabelRemoved >	get_labels_removed () const

client::JsonCppArray< HistoryLabelRemoved >	mutable_labelsRemoved ()

bool	has_messages () const

void	clear_messages ()

const client::JsonCppArray< Message >	get_messages () const

client::JsonCppArray< Message >	mutable_messages ()

bool	has_messages_added () const

void	clear_messages_added ()

const client::JsonCppArray< HistoryMessageAdded >	get_messages_added () const

client::JsonCppArray< HistoryMessageAdded >	mutable_messagesAdded ()

bool	has_messages_deleted () const

void	clear_messages_deleted ()

const client::JsonCppArray< HistoryMessageDeleted >	get_messages_deleted () const

client::JsonCppArray< HistoryMessageDeleted >	mutable_messagesDeleted ()

Static Public Member Functions
static History *	New ()

Detailed Description

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

Constructor & Destructor Documentation

◆ History() [1/2]

google_gmail_api::History::History ( const Json::Value & storage )

explicit

Standard constructor for an immutable data object instance.

Parameters

[in] storage The underlying data storage for this instance.

◆ History() [2/2]

google_gmail_api::History::History ( Json::Value * storage )

explicit

Standard constructor for a mutable data object instance.

Parameters

[in] storage The underlying data storage for this instance.

◆ ~History()

google_gmail_api::History::~History ( )

virtual

Standard destructor.

Member Function Documentation

◆ clear_id()

void google_gmail_api::History::clear_id ( )

inline

Clears the 'id' attribute.

◆ clear_labels_added()

void google_gmail_api::History::clear_labels_added ( )

inline

Clears the 'labelsAdded' attribute.

◆ clear_labels_removed()

void google_gmail_api::History::clear_labels_removed ( )

inline

Clears the 'labelsRemoved' attribute.

◆ clear_messages()

void google_gmail_api::History::clear_messages ( )

inline

Clears the 'messages' attribute.

◆ clear_messages_added()

void google_gmail_api::History::clear_messages_added ( )

inline

Clears the 'messagesAdded' attribute.

◆ clear_messages_deleted()

void google_gmail_api::History::clear_messages_deleted ( )

inline

Clears the 'messagesDeleted' attribute.

◆ get_id()

uint64 google_gmail_api::History::get_id ( ) const

inline

Get the value of the 'id' attribute.

◆ get_labels_added()

const client::JsonCppArray<HistoryLabelAdded > google_gmail_api::History::get_labels_added ( ) const

Get a reference to the value of the 'labelsAdded' attribute.

◆ get_labels_removed()

const client::JsonCppArray<HistoryLabelRemoved > google_gmail_api::History::get_labels_removed ( ) const

Get a reference to the value of the 'labelsRemoved' attribute.

◆ get_messages()

const client::JsonCppArray<Message > google_gmail_api::History::get_messages ( ) const

Get a reference to the value of the 'messages' attribute.

◆ get_messages_added()

const client::JsonCppArray<HistoryMessageAdded > google_gmail_api::History::get_messages_added ( ) const

Get a reference to the value of the 'messagesAdded' attribute.

◆ get_messages_deleted()

const client::JsonCppArray<HistoryMessageDeleted > google_gmail_api::History::get_messages_deleted ( ) const

Get a reference to the value of the 'messagesDeleted' attribute.

◆ GetTypeName()

const StringPiece google_gmail_api::History::GetTypeName ( ) const

inline

Returns a string denoting the type of this data object.

Returns: google_gmail_api::History

◆ has_id()

bool google_gmail_api::History::has_id ( ) const

inline

Determine if the 'id' attribute was set.

Returns: true if the 'id' attribute was set.

◆ has_labels_added()

bool google_gmail_api::History::has_labels_added ( ) const

inline

Determine if the 'labelsAdded' attribute was set.

Returns: true if the 'labelsAdded' attribute was set.

◆ has_labels_removed()

bool google_gmail_api::History::has_labels_removed ( ) const

inline

Determine if the 'labelsRemoved' attribute was set.

Returns: true if the 'labelsRemoved' attribute was set.

◆ has_messages()

bool google_gmail_api::History::has_messages ( ) const

inline

Determine if the 'messages' attribute was set.

Returns: true if the 'messages' attribute was set.

◆ has_messages_added()

bool google_gmail_api::History::has_messages_added ( ) const

inline

Determine if the 'messagesAdded' attribute was set.

Returns: true if the 'messagesAdded' attribute was set.

◆ has_messages_deleted()

bool google_gmail_api::History::has_messages_deleted ( ) const

inline

Determine if the 'messagesDeleted' attribute was set.

Returns: true if the 'messagesDeleted' attribute was set.

◆ mutable_labelsAdded()

client::JsonCppArray<HistoryLabelAdded > google_gmail_api::History::mutable_labelsAdded ( )

Gets a reference to a mutable value of the 'labelsAdded' property.

Labels added to messages in this history record.

Returns: The result can be modified to change the attribute value.

◆ mutable_labelsRemoved()

client::JsonCppArray<HistoryLabelRemoved > google_gmail_api::History::mutable_labelsRemoved ( )

Gets a reference to a mutable value of the 'labelsRemoved' property.

Labels removed from messages in this history record.

Returns: The result can be modified to change the attribute value.

◆ mutable_messages()

client::JsonCppArray<Message > google_gmail_api::History::mutable_messages ( )

Gets a reference to a mutable value of the 'messages' property.

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: The result can be modified to change the attribute value.

◆ mutable_messagesAdded()

client::JsonCppArray<HistoryMessageAdded > google_gmail_api::History::mutable_messagesAdded ( )

Gets a reference to a mutable value of the 'messagesAdded' property.

Messages added to the mailbox in this history record.

Returns: The result can be modified to change the attribute value.

◆ mutable_messagesDeleted()

client::JsonCppArray<HistoryMessageDeleted > google_gmail_api::History::mutable_messagesDeleted ( )

Gets a reference to a mutable value of the 'messagesDeleted' property.

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

Returns: The result can be modified to change the attribute value.

◆ New()

History * google_gmail_api::History::New ( )

static

Creates a new default instance.

Returns: Ownership is passed back to the caller.

◆ set_id()

void google_gmail_api::History::set_id ( uint64 value )

inline

Change the 'id' attribute.

The mailbox sequence ID.

Parameters

[in] value The new value.

The documentation for this class was generated from the following files:

google/gmail_api/history.h
google/gmail_api/history.cc

Public Member Functions

Static Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ History() [1/2]

◆ History() [2/2]

◆ ~History()

Member Function Documentation

◆ clear_id()

◆ clear_labels_added()

◆ clear_labels_removed()

◆ clear_messages()

◆ clear_messages_added()

◆ clear_messages_deleted()

◆ get_id()

◆ get_labels_added()

◆ get_labels_removed()

◆ get_messages()

◆ get_messages_added()

◆ get_messages_deleted()

◆ GetTypeName()

◆ has_id()

◆ has_labels_added()

◆ has_labels_removed()

◆ has_messages()

◆ has_messages_added()

◆ has_messages_deleted()

◆ mutable_labelsAdded()

◆ mutable_labelsRemoved()

◆ mutable_messages()

◆ mutable_messagesAdded()

◆ mutable_messagesDeleted()

◆ New()

◆ set_id()