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

#include <snapshot.h>

Inheritance diagram for google_games_api::Snapshot:

Public Member Functions

 Snapshot (const Json::Value &storage)
 
 Snapshot (Json::Value *storage)
 
virtual ~Snapshot ()
 
const StringPiece GetTypeName () const
 
bool has_cover_image () const
 
void clear_cover_image ()
 
const SnapshotImage get_cover_image () const
 
SnapshotImage mutable_coverImage ()
 
bool has_description () const
 
void clear_description ()
 
const StringPiece get_description () const
 
void set_description (const StringPiece &value)
 
bool has_drive_id () const
 
void clear_drive_id ()
 
const StringPiece get_drive_id () const
 
void set_drive_id (const StringPiece &value)
 
bool has_duration_millis () const
 
void clear_duration_millis ()
 
int64 get_duration_millis () const
 
void set_duration_millis (int64 value)
 
bool has_id () const
 
void clear_id ()
 
const StringPiece get_id () const
 
void set_id (const StringPiece &value)
 
bool has_kind () const
 
void clear_kind ()
 
const StringPiece get_kind () const
 
void set_kind (const StringPiece &value)
 
bool has_last_modified_millis () const
 
void clear_last_modified_millis ()
 
int64 get_last_modified_millis () const
 
void set_last_modified_millis (int64 value)
 
bool has_progress_value () const
 
void clear_progress_value ()
 
int64 get_progress_value () const
 
void set_progress_value (int64 value)
 
bool has_title () const
 
void clear_title ()
 
const StringPiece get_title () const
 
void set_title (const StringPiece &value)
 
bool has_type () const
 
void clear_type ()
 
const StringPiece get_type () const
 
void set_type (const StringPiece &value)
 
bool has_unique_name () const
 
void clear_unique_name ()
 
const StringPiece get_unique_name () const
 
void set_unique_name (const StringPiece &value)
 

Static Public Member Functions

static SnapshotNew ()
 

Detailed Description

This is a JSON template for an snapshot object.

Constructor & Destructor Documentation

◆ Snapshot() [1/2]

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

Standard constructor for an immutable data object instance.

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

◆ Snapshot() [2/2]

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

Standard constructor for a mutable data object instance.

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

◆ ~Snapshot()

google_games_api::Snapshot::~Snapshot ( )
virtual

Standard destructor.

Member Function Documentation

◆ clear_cover_image()

void google_games_api::Snapshot::clear_cover_image ( )
inline

Clears the 'coverImage' attribute.

◆ clear_description()

void google_games_api::Snapshot::clear_description ( )
inline

Clears the 'description' attribute.

◆ clear_drive_id()

void google_games_api::Snapshot::clear_drive_id ( )
inline

Clears the 'driveId' attribute.

◆ clear_duration_millis()

void google_games_api::Snapshot::clear_duration_millis ( )
inline

Clears the 'durationMillis' attribute.

◆ clear_id()

void google_games_api::Snapshot::clear_id ( )
inline

Clears the 'id' attribute.

◆ clear_kind()

void google_games_api::Snapshot::clear_kind ( )
inline

Clears the 'kind' attribute.

◆ clear_last_modified_millis()

void google_games_api::Snapshot::clear_last_modified_millis ( )
inline

Clears the 'lastModifiedMillis' attribute.

◆ clear_progress_value()

void google_games_api::Snapshot::clear_progress_value ( )
inline

Clears the 'progressValue' attribute.

◆ clear_title()

void google_games_api::Snapshot::clear_title ( )
inline

Clears the 'title' attribute.

◆ clear_type()

void google_games_api::Snapshot::clear_type ( )
inline

Clears the 'type' attribute.

◆ clear_unique_name()

void google_games_api::Snapshot::clear_unique_name ( )
inline

Clears the 'uniqueName' attribute.

◆ get_cover_image()

const SnapshotImage google_games_api::Snapshot::get_cover_image ( ) const

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

◆ get_description()

const StringPiece google_games_api::Snapshot::get_description ( ) const
inline

Get the value of the 'description' attribute.

◆ get_drive_id()

const StringPiece google_games_api::Snapshot::get_drive_id ( ) const
inline

Get the value of the 'driveId' attribute.

◆ get_duration_millis()

int64 google_games_api::Snapshot::get_duration_millis ( ) const
inline

Get the value of the 'durationMillis' attribute.

◆ get_id()

const StringPiece google_games_api::Snapshot::get_id ( ) const
inline

Get the value of the 'id' attribute.

◆ get_kind()

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

Get the value of the 'kind' attribute.

◆ get_last_modified_millis()

int64 google_games_api::Snapshot::get_last_modified_millis ( ) const
inline

Get the value of the 'lastModifiedMillis' attribute.

◆ get_progress_value()

int64 google_games_api::Snapshot::get_progress_value ( ) const
inline

Get the value of the 'progressValue' attribute.

◆ get_title()

const StringPiece google_games_api::Snapshot::get_title ( ) const
inline

Get the value of the 'title' attribute.

◆ get_type()

const StringPiece google_games_api::Snapshot::get_type ( ) const
inline

Get the value of the 'type' attribute.

◆ get_unique_name()

const StringPiece google_games_api::Snapshot::get_unique_name ( ) const
inline

Get the value of the 'uniqueName' attribute.

◆ GetTypeName()

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

Returns a string denoting the type of this data object.

Returns
google_games_api::Snapshot

◆ has_cover_image()

bool google_games_api::Snapshot::has_cover_image ( ) const
inline

Determine if the 'coverImage' attribute was set.

Returns
true if the 'coverImage' attribute was set.

◆ has_description()

bool google_games_api::Snapshot::has_description ( ) const
inline

Determine if the 'description' attribute was set.

Returns
true if the 'description' attribute was set.

◆ has_drive_id()

bool google_games_api::Snapshot::has_drive_id ( ) const
inline

Determine if the 'driveId' attribute was set.

Returns
true if the 'driveId' attribute was set.

◆ has_duration_millis()

bool google_games_api::Snapshot::has_duration_millis ( ) const
inline

Determine if the 'durationMillis' attribute was set.

Returns
true if the 'durationMillis' attribute was set.

◆ has_id()

bool google_games_api::Snapshot::has_id ( ) const
inline

Determine if the 'id' attribute was set.

Returns
true if the 'id' attribute was set.

◆ has_kind()

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

Determine if the 'kind' attribute was set.

Returns
true if the 'kind' attribute was set.

◆ has_last_modified_millis()

bool google_games_api::Snapshot::has_last_modified_millis ( ) const
inline

Determine if the 'lastModifiedMillis' attribute was set.

Returns
true if the 'lastModifiedMillis' attribute was set.

◆ has_progress_value()

bool google_games_api::Snapshot::has_progress_value ( ) const
inline

Determine if the 'progressValue' attribute was set.

Returns
true if the 'progressValue' attribute was set.

◆ has_title()

bool google_games_api::Snapshot::has_title ( ) const
inline

Determine if the 'title' attribute was set.

Returns
true if the 'title' attribute was set.

◆ has_type()

bool google_games_api::Snapshot::has_type ( ) const
inline

Determine if the 'type' attribute was set.

Returns
true if the 'type' attribute was set.

◆ has_unique_name()

bool google_games_api::Snapshot::has_unique_name ( ) const
inline

Determine if the 'uniqueName' attribute was set.

Returns
true if the 'uniqueName' attribute was set.

◆ mutable_coverImage()

SnapshotImage google_games_api::Snapshot::mutable_coverImage ( )

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

The cover image of this snapshot. May be absent if there is no image.

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

◆ New()

Snapshot * google_games_api::Snapshot::New ( )
static

Creates a new default instance.

Returns
Ownership is passed back to the caller.

◆ set_description()

void google_games_api::Snapshot::set_description ( const StringPiece &  value)
inline

Change the 'description' attribute.

The description of this snapshot.

Parameters
[in]valueThe new value.

◆ set_drive_id()

void google_games_api::Snapshot::set_drive_id ( const StringPiece &  value)
inline

Change the 'driveId' attribute.

The ID of the file underlying this snapshot in the Drive API. Only present if the snapshot is a view on a Drive file and the file is owned by the caller.

Parameters
[in]valueThe new value.

◆ set_duration_millis()

void google_games_api::Snapshot::set_duration_millis ( int64  value)
inline

Change the 'durationMillis' attribute.

The duration associated with this snapshot, in millis.

Parameters
[in]valueThe new value.

◆ set_id()

void google_games_api::Snapshot::set_id ( const StringPiece &  value)
inline

Change the 'id' attribute.

The ID of the snapshot.

Parameters
[in]valueThe new value.

◆ set_kind()

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

Change the 'kind' attribute.

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

Parameters
[in]valueThe new value.

◆ set_last_modified_millis()

void google_games_api::Snapshot::set_last_modified_millis ( int64  value)
inline

Change the 'lastModifiedMillis' attribute.

The timestamp (in millis since Unix epoch) of the last modification to this snapshot.

Parameters
[in]valueThe new value.

◆ set_progress_value()

void google_games_api::Snapshot::set_progress_value ( int64  value)
inline

Change the 'progressValue' attribute.

The progress value (64-bit integer set by developer) associated with this snapshot.

Parameters
[in]valueThe new value.

◆ set_title()

void google_games_api::Snapshot::set_title ( const StringPiece &  value)
inline

Change the 'title' attribute.

The title of this snapshot.

Parameters
[in]valueThe new value.

◆ set_type()

void google_games_api::Snapshot::set_type ( const StringPiece &  value)
inline

Change the 'type' attribute.

The type of this snapshot. Possible values are:

  • "SAVE_GAME" - A snapshot representing a save game.
Parameters
[in]valueThe new value.

◆ set_unique_name()

void google_games_api::Snapshot::set_unique_name ( const StringPiece &  value)
inline

Change the 'uniqueName' attribute.

The unique name provided when the snapshot was created.

Parameters
[in]valueThe new value.

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