google_gmail_api::ListMessagesResponse Class Reference

#include <list_messages_response.h>

Inheritance diagram for google_gmail_api::ListMessagesResponse:

Public Member Functions
	ListMessagesResponse (const Json::Value &storage)
	ListMessagesResponse (Json::Value *storage)
virtual	~ListMessagesResponse ()
const StringPiece	GetTypeName () const
bool	has_messages () const
void	clear_messages ()
const client::JsonCppArray< Message >	get_messages () const
client::JsonCppArray< Message >	mutable_messages ()
bool	has_next_page_token () const
void	clear_next_page_token ()
const StringPiece	get_next_page_token () const
void	set_next_page_token (const StringPiece &value)
bool	has_result_size_estimate () const
void	clear_result_size_estimate ()
uint32	get_result_size_estimate () const
void	set_result_size_estimate (uint32 value)

Static Public Member Functions
static ListMessagesResponse *	New ()

Detailed Description

No description provided.

Constructor & Destructor Documentation

ListMessagesResponse() [1/2]

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

explicit

Standard constructor for an immutable data object instance.

Parameters

[in]

storage

The underlying data storage for this instance.

ListMessagesResponse() [2/2]

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

explicit

Standard constructor for a mutable data object instance.

Parameters

[in]

storage

The underlying data storage for this instance.

~ListMessagesResponse()

google_gmail_api::ListMessagesResponse::~ListMessagesResponse ( )

virtual

Standard destructor.

Member Function Documentation

clear_messages()

void google_gmail_api::ListMessagesResponse::clear_messages ( )

inline

Clears the 'messages' attribute.

clear_next_page_token()

void google_gmail_api::ListMessagesResponse::clear_next_page_token ( )

inline

Clears the 'nextPageToken' attribute.

clear_result_size_estimate()

void google_gmail_api::ListMessagesResponse::clear_result_size_estimate ( )

inline

Clears the 'resultSizeEstimate' attribute.

get_messages()

const client::JsonCppArray<Message > google_gmail_api::ListMessagesResponse::get_messages

(

)

const

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

get_next_page_token()

const StringPiece google_gmail_api::ListMessagesResponse::get_next_page_token ( ) const

inline

Get the value of the 'nextPageToken' attribute.

get_result_size_estimate()

uint32 google_gmail_api::ListMessagesResponse::get_result_size_estimate ( ) const

inline

Get the value of the 'resultSizeEstimate' attribute.

GetTypeName()

const StringPiece google_gmail_api::ListMessagesResponse::GetTypeName ( ) const

inline

Returns a string denoting the type of this data object.

Returns

google_gmail_api::ListMessagesResponse

has_messages()

bool google_gmail_api::ListMessagesResponse::has_messages ( ) const

inline

Determine if the 'messages' attribute was set.

Returns

true if the 'messages' attribute was set.

has_next_page_token()

bool google_gmail_api::ListMessagesResponse::has_next_page_token ( ) const

inline

Determine if the 'nextPageToken' attribute was set.

Returns

true if the 'nextPageToken' attribute was set.

has_result_size_estimate()

bool google_gmail_api::ListMessagesResponse::has_result_size_estimate ( ) const

inline

Determine if the 'resultSizeEstimate' attribute was set.

Returns

true if the 'resultSizeEstimate' attribute was set.

mutable_messages()

client::JsonCppArray<Message > google_gmail_api::ListMessagesResponse::mutable_messages

(

)

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

List of messages. Note that each message resource contains only an id and a threadId. Additional message details can be fetched using the messages.get method.

Returns

The result can be modified to change the attribute value.

New()

ListMessagesResponse * google_gmail_api::ListMessagesResponse::New ( )

static

Creates a new default instance.

Returns

Ownership is passed back to the caller.

set_next_page_token()

void google_gmail_api::ListMessagesResponse::set_next_page_token ( const StringPiece &  value )

inline

Change the 'nextPageToken' attribute.

Token to retrieve the next page of results in the list.

Parameters

[in]

value

The new value.

set_result_size_estimate()

void google_gmail_api::ListMessagesResponse::set_result_size_estimate ( uint32  value )

inline

Change the 'resultSizeEstimate' attribute.

Estimated total number of results.

Parameters

[in]

value

The new value.

---

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

• google/gmail_api/list_messages_response.h
• google/gmail_api/list_messages_response.cc