#include <label.h>

Inheritance diagram for google_gmail_api::Label:

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

	Label (Json::Value *storage)

virtual	~Label ()

const StringPiece	GetTypeName () const

bool	has_color () const

void	clear_color ()

const LabelColor	get_color () const

LabelColor	mutable_color ()

bool	has_id () const

void	clear_id ()

const StringPiece	get_id () const

void	set_id (const StringPiece &value)

bool	has_label_list_visibility () const

void	clear_label_list_visibility ()

const StringPiece	get_label_list_visibility () const

void	set_label_list_visibility (const StringPiece &value)

bool	has_message_list_visibility () const

void	clear_message_list_visibility ()

const StringPiece	get_message_list_visibility () const

void	set_message_list_visibility (const StringPiece &value)

bool	has_messages_total () const

void	clear_messages_total ()

int32	get_messages_total () const

void	set_messages_total (int32 value)

bool	has_messages_unread () const

void	clear_messages_unread ()

int32	get_messages_unread () const

void	set_messages_unread (int32 value)

bool	has_name () const

void	clear_name ()

const StringPiece	get_name () const

void	set_name (const StringPiece &value)

bool	has_threads_total () const

void	clear_threads_total ()

int32	get_threads_total () const

void	set_threads_total (int32 value)

bool	has_threads_unread () const

void	clear_threads_unread ()

int32	get_threads_unread () const

void	set_threads_unread (int32 value)

bool	has_type () const

void	clear_type ()

const StringPiece	get_type () const

void	set_type (const StringPiece &value)

Static Public Member Functions
static Label *	New ()

Detailed Description

Labels are used to categorize messages and threads within the user's mailbox.

Constructor & Destructor Documentation

◆ Label() [1/2]

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

explicit

Standard constructor for an immutable data object instance.

Parameters

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

◆ Label() [2/2]

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

explicit

Standard constructor for a mutable data object instance.

Parameters

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

◆ ~Label()

google_gmail_api::Label::~Label ( )

virtual

Standard destructor.

Member Function Documentation

◆ clear_color()

void google_gmail_api::Label::clear_color ( )

inline

Clears the 'color' attribute.

◆ clear_id()

void google_gmail_api::Label::clear_id ( )

inline

Clears the 'id' attribute.

◆ clear_label_list_visibility()

void google_gmail_api::Label::clear_label_list_visibility ( )

inline

Clears the 'labelListVisibility' attribute.

◆ clear_message_list_visibility()

void google_gmail_api::Label::clear_message_list_visibility ( )

inline

Clears the 'messageListVisibility' attribute.

◆ clear_messages_total()

void google_gmail_api::Label::clear_messages_total ( )

inline

Clears the 'messagesTotal' attribute.

◆ clear_messages_unread()

void google_gmail_api::Label::clear_messages_unread ( )

inline

Clears the 'messagesUnread' attribute.

◆ clear_name()

void google_gmail_api::Label::clear_name ( )

inline

Clears the 'name' attribute.

◆ clear_threads_total()

void google_gmail_api::Label::clear_threads_total ( )

inline

Clears the 'threadsTotal' attribute.

◆ clear_threads_unread()

void google_gmail_api::Label::clear_threads_unread ( )

inline

Clears the 'threadsUnread' attribute.

◆ clear_type()

void google_gmail_api::Label::clear_type ( )

inline

Clears the 'type' attribute.

◆ get_color()

const LabelColor google_gmail_api::Label::get_color ( ) const

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

◆ get_id()

const StringPiece google_gmail_api::Label::get_id ( ) const

inline

Get the value of the 'id' attribute.

◆ get_label_list_visibility()

const StringPiece google_gmail_api::Label::get_label_list_visibility ( ) const

inline

Get the value of the 'labelListVisibility' attribute.

◆ get_message_list_visibility()

const StringPiece google_gmail_api::Label::get_message_list_visibility ( ) const

inline

Get the value of the 'messageListVisibility' attribute.

◆ get_messages_total()

int32 google_gmail_api::Label::get_messages_total ( ) const

inline

Get the value of the 'messagesTotal' attribute.

◆ get_messages_unread()

int32 google_gmail_api::Label::get_messages_unread ( ) const

inline

Get the value of the 'messagesUnread' attribute.

◆ get_name()

const StringPiece google_gmail_api::Label::get_name ( ) const

inline

Get the value of the 'name' attribute.

◆ get_threads_total()

int32 google_gmail_api::Label::get_threads_total ( ) const

inline

Get the value of the 'threadsTotal' attribute.

◆ get_threads_unread()

int32 google_gmail_api::Label::get_threads_unread ( ) const

inline

Get the value of the 'threadsUnread' attribute.

◆ get_type()

const StringPiece google_gmail_api::Label::get_type ( ) const

inline

Get the value of the 'type' attribute.

◆ GetTypeName()

const StringPiece google_gmail_api::Label::GetTypeName ( ) const

inline

Returns a string denoting the type of this data object.

Returns: google_gmail_api::Label

◆ has_color()

bool google_gmail_api::Label::has_color ( ) const

inline

Determine if the 'color' attribute was set.

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

◆ has_id()

bool google_gmail_api::Label::has_id ( ) const

inline

Determine if the 'id' attribute was set.

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

◆ has_label_list_visibility()

bool google_gmail_api::Label::has_label_list_visibility ( ) const

inline

Determine if the 'labelListVisibility' attribute was set.

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

◆ has_message_list_visibility()

bool google_gmail_api::Label::has_message_list_visibility ( ) const

inline

Determine if the 'messageListVisibility' attribute was set.

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

◆ has_messages_total()

bool google_gmail_api::Label::has_messages_total ( ) const

inline

Determine if the 'messagesTotal' attribute was set.

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

◆ has_messages_unread()

bool google_gmail_api::Label::has_messages_unread ( ) const

inline

Determine if the 'messagesUnread' attribute was set.

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

◆ has_name()

bool google_gmail_api::Label::has_name ( ) const

inline

Determine if the 'name' attribute was set.

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

◆ has_threads_total()

bool google_gmail_api::Label::has_threads_total ( ) const

inline

Determine if the 'threadsTotal' attribute was set.

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

◆ has_threads_unread()

bool google_gmail_api::Label::has_threads_unread ( ) const

inline

Determine if the 'threadsUnread' attribute was set.

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

◆ has_type()

bool google_gmail_api::Label::has_type ( ) const

inline

Determine if the 'type' attribute was set.

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

◆ mutable_color()

LabelColor google_gmail_api::Label::mutable_color ( )

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

The color to assign to the label. Color is only available for labels that have their type set to user.

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

◆ New()

Label * google_gmail_api::Label::New ( )

static

Creates a new default instance.

Returns: Ownership is passed back to the caller.

◆ set_id()

void google_gmail_api::Label::set_id ( const StringPiece & value )

inline

Change the 'id' attribute.

The immutable ID of the label.

Parameters

[in] value The new value.

◆ set_label_list_visibility()

void google_gmail_api::Label::set_label_list_visibility ( const StringPiece & value )

inline

Change the 'labelListVisibility' attribute.

The visibility of the label in the label list in the Gmail web interface.

Parameters

[in] value The new value.

◆ set_message_list_visibility()

void google_gmail_api::Label::set_message_list_visibility ( const StringPiece & value )

inline

Change the 'messageListVisibility' attribute.

The visibility of the label in the message list in the Gmail web interface.

Parameters

[in] value The new value.

◆ set_messages_total()

void google_gmail_api::Label::set_messages_total ( int32 value )

inline

Change the 'messagesTotal' attribute.

The total number of messages with the label.

Parameters

[in] value The new value.

◆ set_messages_unread()

void google_gmail_api::Label::set_messages_unread ( int32 value )

inline

Change the 'messagesUnread' attribute.

The number of unread messages with the label.

Parameters

[in] value The new value.

◆ set_name()

void google_gmail_api::Label::set_name ( const StringPiece & value )

inline

Change the 'name' attribute.

The display name of the label.

Parameters

[in] value The new value.

◆ set_threads_total()

void google_gmail_api::Label::set_threads_total ( int32 value )

inline

Change the 'threadsTotal' attribute.

The total number of threads with the label.

Parameters

[in] value The new value.

◆ set_threads_unread()

void google_gmail_api::Label::set_threads_unread ( int32 value )

inline

Change the 'threadsUnread' attribute.

The number of unread threads with the label.

Parameters

[in] value The new value.

◆ set_type()

void google_gmail_api::Label::set_type ( const StringPiece & value )

inline

Change the 'type' attribute.

The owner type for the label. User labels are created by the user and can be modified and deleted by the user and can be applied to any message or thread. System labels are internally created and cannot be added, modified, or deleted. System labels may be able to be applied to or removed from messages and threads under some circumstances but this is not guaranteed. For example, users can apply and remove the INBOX and UNREAD labels from messages and threads, but cannot apply or remove the DRAFTS or SENT labels from messages or threads.

Parameters

[in] value The new value.

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

google/gmail_api/label.h
google/gmail_api/label.cc

Public Member Functions

Static Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ Label() [1/2]

◆ Label() [2/2]

◆ ~Label()

Member Function Documentation

◆ clear_color()

◆ clear_id()

◆ clear_label_list_visibility()

◆ clear_message_list_visibility()

◆ clear_messages_total()

◆ clear_messages_unread()

◆ clear_name()

◆ clear_threads_total()

◆ clear_threads_unread()

◆ clear_type()

◆ get_color()

◆ get_id()

◆ get_label_list_visibility()

◆ get_message_list_visibility()

◆ get_messages_total()

◆ get_messages_unread()

◆ get_name()

◆ get_threads_total()

◆ get_threads_unread()

◆ get_type()

◆ GetTypeName()

◆ has_color()

◆ has_id()

◆ has_label_list_visibility()

◆ has_message_list_visibility()

◆ has_messages_total()

◆ has_messages_unread()

◆ has_name()

◆ has_threads_total()

◆ has_threads_unread()

◆ has_type()

◆ mutable_color()

◆ New()

◆ set_id()

◆ set_label_list_visibility()

◆ set_message_list_visibility()

◆ set_messages_total()

◆ set_messages_unread()

◆ set_name()

◆ set_threads_total()

◆ set_threads_unread()

◆ set_type()