gmail  v1
Public Member Functions | Static Public Member Functions | List of all members
google_gmail_api::BatchModifyMessagesRequest Class Reference

#include <batch_modify_messages_request.h>

Inheritance diagram for google_gmail_api::BatchModifyMessagesRequest:

Public Member Functions

 BatchModifyMessagesRequest (const Json::Value &storage)
 
 BatchModifyMessagesRequest (Json::Value *storage)
 
virtual ~BatchModifyMessagesRequest ()
 
const StringPiece GetTypeName () const
 
bool has_add_label_ids () const
 
void clear_add_label_ids ()
 
const client::JsonCppArray< string > get_add_label_ids () const
 
client::JsonCppArray< string > mutable_addLabelIds ()
 
bool has_ids () const
 
void clear_ids ()
 
const client::JsonCppArray< string > get_ids () const
 
client::JsonCppArray< string > mutable_ids ()
 
bool has_remove_label_ids () const
 
void clear_remove_label_ids ()
 
const client::JsonCppArray< string > get_remove_label_ids () const
 
client::JsonCppArray< string > mutable_removeLabelIds ()
 

Static Public Member Functions

static BatchModifyMessagesRequestNew ()
 

Detailed Description

No description provided.

Constructor & Destructor Documentation

◆ BatchModifyMessagesRequest() [1/2]

google_gmail_api::BatchModifyMessagesRequest::BatchModifyMessagesRequest ( const Json::Value &  storage)
explicit

Standard constructor for an immutable data object instance.

Parameters
[in]storageThe underlying data storage for this instance.

◆ BatchModifyMessagesRequest() [2/2]

google_gmail_api::BatchModifyMessagesRequest::BatchModifyMessagesRequest ( Json::Value *  storage)
explicit

Standard constructor for a mutable data object instance.

Parameters
[in]storageThe underlying data storage for this instance.

◆ ~BatchModifyMessagesRequest()

google_gmail_api::BatchModifyMessagesRequest::~BatchModifyMessagesRequest ( )
virtual

Standard destructor.

Member Function Documentation

◆ clear_add_label_ids()

void google_gmail_api::BatchModifyMessagesRequest::clear_add_label_ids ( )
inline

Clears the 'addLabelIds' attribute.

◆ clear_ids()

void google_gmail_api::BatchModifyMessagesRequest::clear_ids ( )
inline

Clears the 'ids' attribute.

◆ clear_remove_label_ids()

void google_gmail_api::BatchModifyMessagesRequest::clear_remove_label_ids ( )
inline

Clears the 'removeLabelIds' attribute.

◆ get_add_label_ids()

const client::JsonCppArray<string > google_gmail_api::BatchModifyMessagesRequest::get_add_label_ids ( ) const
inline

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

◆ get_ids()

const client::JsonCppArray<string > google_gmail_api::BatchModifyMessagesRequest::get_ids ( ) const
inline

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

◆ get_remove_label_ids()

const client::JsonCppArray<string > google_gmail_api::BatchModifyMessagesRequest::get_remove_label_ids ( ) const
inline

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

◆ GetTypeName()

const StringPiece google_gmail_api::BatchModifyMessagesRequest::GetTypeName ( ) const
inline

Returns a string denoting the type of this data object.

Returns
google_gmail_api::BatchModifyMessagesRequest

◆ has_add_label_ids()

bool google_gmail_api::BatchModifyMessagesRequest::has_add_label_ids ( ) const
inline

Determine if the 'addLabelIds' attribute was set.

Returns
true if the 'addLabelIds' attribute was set.

◆ has_ids()

bool google_gmail_api::BatchModifyMessagesRequest::has_ids ( ) const
inline

Determine if the 'ids' attribute was set.

Returns
true if the 'ids' attribute was set.

◆ has_remove_label_ids()

bool google_gmail_api::BatchModifyMessagesRequest::has_remove_label_ids ( ) const
inline

Determine if the 'removeLabelIds' attribute was set.

Returns
true if the 'removeLabelIds' attribute was set.

◆ mutable_addLabelIds()

client::JsonCppArray<string > google_gmail_api::BatchModifyMessagesRequest::mutable_addLabelIds ( )
inline

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

A list of label IDs to add to messages.

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

◆ mutable_ids()

client::JsonCppArray<string > google_gmail_api::BatchModifyMessagesRequest::mutable_ids ( )
inline

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

The IDs of the messages to modify. There is a limit of 1000 ids per request.

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

◆ mutable_removeLabelIds()

client::JsonCppArray<string > google_gmail_api::BatchModifyMessagesRequest::mutable_removeLabelIds ( )
inline

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

A list of label IDs to remove from messages.

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

◆ New()

BatchModifyMessagesRequest * google_gmail_api::BatchModifyMessagesRequest::New ( )
static

Creates a new default instance.

Returns
Ownership is passed back to the caller.

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