games  v1
Public Member Functions | Static Public Member Functions | List of all members
google_games_api::LeaderboardEntry Class Reference

#include <leaderboard_entry.h>

Inheritance diagram for google_games_api::LeaderboardEntry:

Public Member Functions

 LeaderboardEntry (const Json::Value &storage)
 
 LeaderboardEntry (Json::Value *storage)
 
virtual ~LeaderboardEntry ()
 
const StringPiece GetTypeName () const
 
bool has_formatted_score () const
 
void clear_formatted_score ()
 
const StringPiece get_formatted_score () const
 
void set_formatted_score (const StringPiece &value)
 
bool has_formatted_score_rank () const
 
void clear_formatted_score_rank ()
 
const StringPiece get_formatted_score_rank () const
 
void set_formatted_score_rank (const StringPiece &value)
 
bool has_kind () const
 
void clear_kind ()
 
const StringPiece get_kind () const
 
void set_kind (const StringPiece &value)
 
bool has_player () const
 
void clear_player ()
 
const Player get_player () const
 
Player mutable_player ()
 
bool has_score_rank () const
 
void clear_score_rank ()
 
int64 get_score_rank () const
 
void set_score_rank (int64 value)
 
bool has_score_tag () const
 
void clear_score_tag ()
 
const StringPiece get_score_tag () const
 
void set_score_tag (const StringPiece &value)
 
bool has_score_value () const
 
void clear_score_value ()
 
int64 get_score_value () const
 
void set_score_value (int64 value)
 
bool has_time_span () const
 
void clear_time_span ()
 
const StringPiece get_time_span () const
 
void set_time_span (const StringPiece &value)
 
bool has_write_timestamp_millis () const
 
void clear_write_timestamp_millis ()
 
int64 get_write_timestamp_millis () const
 
void set_write_timestamp_millis (int64 value)
 

Static Public Member Functions

static LeaderboardEntryNew ()
 

Detailed Description

This is a JSON template for the Leaderboard Entry resource.

Constructor & Destructor Documentation

◆ LeaderboardEntry() [1/2]

google_games_api::LeaderboardEntry::LeaderboardEntry ( const Json::Value &  storage)
explicit

Standard constructor for an immutable data object instance.

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

◆ LeaderboardEntry() [2/2]

google_games_api::LeaderboardEntry::LeaderboardEntry ( Json::Value *  storage)
explicit

Standard constructor for a mutable data object instance.

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

◆ ~LeaderboardEntry()

google_games_api::LeaderboardEntry::~LeaderboardEntry ( )
virtual

Standard destructor.

Member Function Documentation

◆ clear_formatted_score()

void google_games_api::LeaderboardEntry::clear_formatted_score ( )
inline

Clears the 'formattedScore' attribute.

◆ clear_formatted_score_rank()

void google_games_api::LeaderboardEntry::clear_formatted_score_rank ( )
inline

Clears the 'formattedScoreRank' attribute.

◆ clear_kind()

void google_games_api::LeaderboardEntry::clear_kind ( )
inline

Clears the 'kind' attribute.

◆ clear_player()

void google_games_api::LeaderboardEntry::clear_player ( )
inline

Clears the 'player' attribute.

◆ clear_score_rank()

void google_games_api::LeaderboardEntry::clear_score_rank ( )
inline

Clears the 'scoreRank' attribute.

◆ clear_score_tag()

void google_games_api::LeaderboardEntry::clear_score_tag ( )
inline

Clears the 'scoreTag' attribute.

◆ clear_score_value()

void google_games_api::LeaderboardEntry::clear_score_value ( )
inline

Clears the 'scoreValue' attribute.

◆ clear_time_span()

void google_games_api::LeaderboardEntry::clear_time_span ( )
inline

Clears the 'timeSpan' attribute.

◆ clear_write_timestamp_millis()

void google_games_api::LeaderboardEntry::clear_write_timestamp_millis ( )
inline

Clears the 'writeTimestampMillis' attribute.

◆ get_formatted_score()

const StringPiece google_games_api::LeaderboardEntry::get_formatted_score ( ) const
inline

Get the value of the 'formattedScore' attribute.

◆ get_formatted_score_rank()

const StringPiece google_games_api::LeaderboardEntry::get_formatted_score_rank ( ) const
inline

Get the value of the 'formattedScoreRank' attribute.

◆ get_kind()

const StringPiece google_games_api::LeaderboardEntry::get_kind ( ) const
inline

Get the value of the 'kind' attribute.

◆ get_player()

const Player google_games_api::LeaderboardEntry::get_player ( ) const

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

◆ get_score_rank()

int64 google_games_api::LeaderboardEntry::get_score_rank ( ) const
inline

Get the value of the 'scoreRank' attribute.

◆ get_score_tag()

const StringPiece google_games_api::LeaderboardEntry::get_score_tag ( ) const
inline

Get the value of the 'scoreTag' attribute.

◆ get_score_value()

int64 google_games_api::LeaderboardEntry::get_score_value ( ) const
inline

Get the value of the 'scoreValue' attribute.

◆ get_time_span()

const StringPiece google_games_api::LeaderboardEntry::get_time_span ( ) const
inline

Get the value of the 'timeSpan' attribute.

◆ get_write_timestamp_millis()

int64 google_games_api::LeaderboardEntry::get_write_timestamp_millis ( ) const
inline

Get the value of the 'writeTimestampMillis' attribute.

◆ GetTypeName()

const StringPiece google_games_api::LeaderboardEntry::GetTypeName ( ) const
inline

Returns a string denoting the type of this data object.

Returns
google_games_api::LeaderboardEntry

◆ has_formatted_score()

bool google_games_api::LeaderboardEntry::has_formatted_score ( ) const
inline

Determine if the 'formattedScore' attribute was set.

Returns
true if the 'formattedScore' attribute was set.

◆ has_formatted_score_rank()

bool google_games_api::LeaderboardEntry::has_formatted_score_rank ( ) const
inline

Determine if the 'formattedScoreRank' attribute was set.

Returns
true if the 'formattedScoreRank' attribute was set.

◆ has_kind()

bool google_games_api::LeaderboardEntry::has_kind ( ) const
inline

Determine if the 'kind' attribute was set.

Returns
true if the 'kind' attribute was set.

◆ has_player()

bool google_games_api::LeaderboardEntry::has_player ( ) const
inline

Determine if the 'player' attribute was set.

Returns
true if the 'player' attribute was set.

◆ has_score_rank()

bool google_games_api::LeaderboardEntry::has_score_rank ( ) const
inline

Determine if the 'scoreRank' attribute was set.

Returns
true if the 'scoreRank' attribute was set.

◆ has_score_tag()

bool google_games_api::LeaderboardEntry::has_score_tag ( ) const
inline

Determine if the 'scoreTag' attribute was set.

Returns
true if the 'scoreTag' attribute was set.

◆ has_score_value()

bool google_games_api::LeaderboardEntry::has_score_value ( ) const
inline

Determine if the 'scoreValue' attribute was set.

Returns
true if the 'scoreValue' attribute was set.

◆ has_time_span()

bool google_games_api::LeaderboardEntry::has_time_span ( ) const
inline

Determine if the 'timeSpan' attribute was set.

Returns
true if the 'timeSpan' attribute was set.

◆ has_write_timestamp_millis()

bool google_games_api::LeaderboardEntry::has_write_timestamp_millis ( ) const
inline

Determine if the 'writeTimestampMillis' attribute was set.

Returns
true if the 'writeTimestampMillis' attribute was set.

◆ mutable_player()

Player google_games_api::LeaderboardEntry::mutable_player ( )

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

The player who holds this score.

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

◆ New()

LeaderboardEntry * google_games_api::LeaderboardEntry::New ( )
static

Creates a new default instance.

Returns
Ownership is passed back to the caller.

◆ set_formatted_score()

void google_games_api::LeaderboardEntry::set_formatted_score ( const StringPiece &  value)
inline

Change the 'formattedScore' attribute.

The localized string for the numerical value of this score.

Parameters
[in]valueThe new value.

◆ set_formatted_score_rank()

void google_games_api::LeaderboardEntry::set_formatted_score_rank ( const StringPiece &  value)
inline

Change the 'formattedScoreRank' attribute.

The localized string for the rank of this score for this leaderboard.

Parameters
[in]valueThe new value.

◆ set_kind()

void google_games_api::LeaderboardEntry::set_kind ( const StringPiece &  value)
inline

Change the 'kind' attribute.

Uniquely identifies the type of this resource. Value is always the fixed string games::leaderboardEntry.

Parameters
[in]valueThe new value.

◆ set_score_rank()

void google_games_api::LeaderboardEntry::set_score_rank ( int64  value)
inline

Change the 'scoreRank' attribute.

The rank of this score for this leaderboard.

Parameters
[in]valueThe new value.

◆ set_score_tag()

void google_games_api::LeaderboardEntry::set_score_tag ( const StringPiece &  value)
inline

Change the 'scoreTag' attribute.

Additional information about the score. Values must contain no more than 64 URI-safe characters as defined by section 2.3 of RFC 3986.

Parameters
[in]valueThe new value.

◆ set_score_value()

void google_games_api::LeaderboardEntry::set_score_value ( int64  value)
inline

Change the 'scoreValue' attribute.

The numerical value of this score.

Parameters
[in]valueThe new value.

◆ set_time_span()

void google_games_api::LeaderboardEntry::set_time_span ( const StringPiece &  value)
inline

Change the 'timeSpan' attribute.

The time span of this high score. Possible values are:

"ALL_TIME"
The score is an all-time high score.
"WEEKLY"
The score is a weekly high score.
"DAILY"
The score is a daily high score.
Parameters
[in]valueThe new value.

◆ set_write_timestamp_millis()

void google_games_api::LeaderboardEntry::set_write_timestamp_millis ( int64  value)
inline

Change the 'writeTimestampMillis' attribute.

The timestamp at which this score was recorded, in milliseconds since the epoch in UTC.

Parameters
[in]valueThe new value.

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