google_gmail_api::WatchRequest Class Reference

#include <watch_request.h>

Inheritance diagram for google_gmail_api::WatchRequest:

Public Member Functions
	WatchRequest (const Json::Value &storage)
	WatchRequest (Json::Value *storage)
virtual	~WatchRequest ()
const StringPiece	GetTypeName () const
bool	has_label_filter_action () const
void	clear_label_filter_action ()
const StringPiece	get_label_filter_action () const
void	set_label_filter_action (const StringPiece &value)
bool	has_label_ids () const
void	clear_label_ids ()
const client::JsonCppArray< string >	get_label_ids () const
client::JsonCppArray< string >	mutable_labelIds ()
bool	has_topic_name () const
void	clear_topic_name ()
const StringPiece	get_topic_name () const
void	set_topic_name (const StringPiece &value)

Static Public Member Functions
static WatchRequest *	New ()

Detailed Description

Set up or update a new push notification watch on this user's mailbox.

Constructor & Destructor Documentation

WatchRequest() [1/2]

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

explicit

Standard constructor for an immutable data object instance.

Parameters

[in]

storage

The underlying data storage for this instance.

WatchRequest() [2/2]

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

explicit

Standard constructor for a mutable data object instance.

Parameters

[in]

storage

The underlying data storage for this instance.

~WatchRequest()

google_gmail_api::WatchRequest::~WatchRequest ( )

virtual

Standard destructor.

Member Function Documentation

clear_label_filter_action()

void google_gmail_api::WatchRequest::clear_label_filter_action ( )

inline

Clears the 'labelFilterAction' attribute.

clear_label_ids()

void google_gmail_api::WatchRequest::clear_label_ids ( )

inline

Clears the 'labelIds' attribute.

clear_topic_name()

void google_gmail_api::WatchRequest::clear_topic_name ( )

inline

Clears the 'topicName' attribute.

get_label_filter_action()

const StringPiece google_gmail_api::WatchRequest::get_label_filter_action ( ) const

inline

Get the value of the 'labelFilterAction' attribute.

get_label_ids()

const client::JsonCppArray<string > google_gmail_api::WatchRequest::get_label_ids ( ) const

inline

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

get_topic_name()

const StringPiece google_gmail_api::WatchRequest::get_topic_name ( ) const

inline

Get the value of the 'topicName' attribute.

GetTypeName()

const StringPiece google_gmail_api::WatchRequest::GetTypeName ( ) const

inline

Returns a string denoting the type of this data object.

Returns

google_gmail_api::WatchRequest

has_label_filter_action()

bool google_gmail_api::WatchRequest::has_label_filter_action ( ) const

inline

Determine if the 'labelFilterAction' attribute was set.

Returns

true if the 'labelFilterAction' attribute was set.

has_label_ids()

bool google_gmail_api::WatchRequest::has_label_ids ( ) const

inline

Determine if the 'labelIds' attribute was set.

Returns

true if the 'labelIds' attribute was set.

has_topic_name()

bool google_gmail_api::WatchRequest::has_topic_name ( ) const

inline

Determine if the 'topicName' attribute was set.

Returns

true if the 'topicName' attribute was set.

mutable_labelIds()

client::JsonCppArray<string > google_gmail_api::WatchRequest::mutable_labelIds ( )

inline

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

List of label_ids to restrict notifications about. By default, if unspecified, all changes are pushed out. If specified then dictates which labels are required for a push notification to be generated.

Returns

The result can be modified to change the attribute value.

New()

WatchRequest * google_gmail_api::WatchRequest::New ( )

static

Creates a new default instance.

Returns

Ownership is passed back to the caller.

set_label_filter_action()

void google_gmail_api::WatchRequest::set_label_filter_action ( const StringPiece &  value )

inline

Change the 'labelFilterAction' attribute.

Filtering behavior of labelIds list specified.

Parameters

[in]

value

The new value.

set_topic_name()

void google_gmail_api::WatchRequest::set_topic_name ( const StringPiece &  value )

inline

Change the 'topicName' attribute.

A fully qualified Google Cloud Pub/Sub API topic name to publish the events to. This topic name must already exist in Cloud Pub/Sub and you must have already granted gmail "publish" permission on it. For example, "projects/my-project-identifier/topics/my-topic-name" (using the Cloud Pub/Sub "v1" topic naming format).

Note that the "my-project-identifier" portion must exactly match your Google developer project id (the one executing this watch request).

Parameters

[in]

value

The new value.

---

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

• google/gmail_api/watch_request.h
• google/gmail_api/watch_request.cc