google_gmail_api::WatchResponse Class Reference

#include <watch_response.h>

Inheritance diagram for google_gmail_api::WatchResponse:

Public Member Functions
	WatchResponse (const Json::Value &storage)
	WatchResponse (Json::Value *storage)
virtual	~WatchResponse ()
const StringPiece	GetTypeName () const
bool	has_expiration () const
void	clear_expiration ()
int64	get_expiration () const
void	set_expiration (int64 value)
bool	has_history_id () const
void	clear_history_id ()
uint64	get_history_id () const
void	set_history_id (uint64 value)

Static Public Member Functions
static WatchResponse *	New ()

Detailed Description

Push notification watch response.

Constructor & Destructor Documentation

WatchResponse() [1/2]

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

explicit

Standard constructor for an immutable data object instance.

Parameters

[in]

storage

The underlying data storage for this instance.

WatchResponse() [2/2]

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

explicit

Standard constructor for a mutable data object instance.

Parameters

[in]

storage

The underlying data storage for this instance.

~WatchResponse()

google_gmail_api::WatchResponse::~WatchResponse ( )

virtual

Standard destructor.

Member Function Documentation

clear_expiration()

void google_gmail_api::WatchResponse::clear_expiration ( )

inline

Clears the 'expiration' attribute.

clear_history_id()

void google_gmail_api::WatchResponse::clear_history_id ( )

inline

Clears the 'historyId' attribute.

get_expiration()

int64 google_gmail_api::WatchResponse::get_expiration ( ) const

inline

Get the value of the 'expiration' attribute.

get_history_id()

uint64 google_gmail_api::WatchResponse::get_history_id ( ) const

inline

Get the value of the 'historyId' attribute.

GetTypeName()

const StringPiece google_gmail_api::WatchResponse::GetTypeName ( ) const

inline

Returns a string denoting the type of this data object.

Returns

google_gmail_api::WatchResponse

has_expiration()

bool google_gmail_api::WatchResponse::has_expiration ( ) const

inline

Determine if the 'expiration' attribute was set.

Returns

true if the 'expiration' attribute was set.

has_history_id()

bool google_gmail_api::WatchResponse::has_history_id ( ) const

inline

Determine if the 'historyId' attribute was set.

Returns

true if the 'historyId' attribute was set.

New()

WatchResponse * google_gmail_api::WatchResponse::New ( )

static

Creates a new default instance.

Returns

Ownership is passed back to the caller.

set_expiration()

void google_gmail_api::WatchResponse::set_expiration ( int64  value )

inline

Change the 'expiration' attribute.

When Gmail will stop sending notifications for mailbox updates (epoch millis). Call watch again before this time to renew the watch.

Parameters

[in]

value

The new value.

set_history_id()

void google_gmail_api::WatchResponse::set_history_id ( uint64  value )

inline

Change the 'historyId' attribute.

The ID of the mailbox's current history record.

Parameters

[in]

value

The new value.

---

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

• google/gmail_api/watch_response.h
• google/gmail_api/watch_response.cc