google_gmail_api::LanguageSettings Class Reference

#include <language_settings.h>

Inheritance diagram for google_gmail_api::LanguageSettings:

Public Member Functions
	LanguageSettings (const Json::Value &storage)
	LanguageSettings (Json::Value *storage)
virtual	~LanguageSettings ()
const StringPiece	GetTypeName () const
bool	has_display_language () const
void	clear_display_language ()
const StringPiece	get_display_language () const
void	set_display_language (const StringPiece &value)

Static Public Member Functions
static LanguageSettings *	New ()

Detailed Description

Language settings for an account. These settings correspond to the "Language settings" feature in the web interface.

Constructor & Destructor Documentation

LanguageSettings() [1/2]

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

explicit

Standard constructor for an immutable data object instance.

Parameters

[in]

storage

The underlying data storage for this instance.

LanguageSettings() [2/2]

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

explicit

Standard constructor for a mutable data object instance.

Parameters

[in]

storage

The underlying data storage for this instance.

~LanguageSettings()

google_gmail_api::LanguageSettings::~LanguageSettings ( )

virtual

Standard destructor.

Member Function Documentation

clear_display_language()

void google_gmail_api::LanguageSettings::clear_display_language ( )

inline

Clears the 'displayLanguage' attribute.

get_display_language()

const StringPiece google_gmail_api::LanguageSettings::get_display_language ( ) const

inline

Get the value of the 'displayLanguage' attribute.

GetTypeName()

const StringPiece google_gmail_api::LanguageSettings::GetTypeName ( ) const

inline

Returns a string denoting the type of this data object.

Returns

google_gmail_api::LanguageSettings

has_display_language()

bool google_gmail_api::LanguageSettings::has_display_language ( ) const

inline

Determine if the 'displayLanguage' attribute was set.

Returns

true if the 'displayLanguage' attribute was set.

New()

LanguageSettings * google_gmail_api::LanguageSettings::New ( )

static

Creates a new default instance.

Returns

Ownership is passed back to the caller.

set_display_language()

void google_gmail_api::LanguageSettings::set_display_language ( const StringPiece &  value )

inline

Change the 'displayLanguage' attribute.

The language to display Gmail in, formatted as an RFC 3066 Language Tag (for example en-GB, fr or ja for British English, French, or Japanese respectively).

The set of languages supported by Gmail evolves over time, so please refer to the "Language" dropdown in the Gmail settings for all available options, as described in the language settings help article. A table of sample values is also provided in the Managing Language Settings guide

Not all Gmail clients can display the same set of languages. In the case that a user's display language is not available for use on a particular client, said client automatically chooses to display in the closest supported variant (or a reasonable default).

Parameters

[in]

value

The new value.

---

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

• google/gmail_api/language_settings.h
• google/gmail_api/language_settings.cc