java.lang.Object | |
↳ | com.google.android.gms.games.snapshot.SnapshotMetadataEntity |
Data object representing the metadata for a saved game. This is immutable, and therefore safe to cache or store. Note, however, that the data it represents may grow stale.
This class exists solely to support parceling these objects and should not be used directly.
[Expand]
Inherited Constants | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
![]() | |||||||||||
![]() |
Fields | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
CREATOR |
Public Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Freeze a volatile representation into an immutable representation.
| |||||||||||
Retrieves the aspect ratio of the cover image for this snapshot, if any.
| |||||||||||
Retrieves an image URI that can be used to load the snapshot's cover image.
| |||||||||||
Retrieves the description of this snapshot.
| |||||||||||
Loads the snapshot description into the given
CharArrayBuffer . | |||||||||||
Retrieves the name of the device that wrote this snapshot, if known.
| |||||||||||
Retrieves the game associated with this snapshot.
| |||||||||||
Retrieves the last time this snapshot was modified, in millis since epoch.
| |||||||||||
Retrieves the player that owns this snapshot.
| |||||||||||
Retrieves the played time of this snapshot in milliseconds.
| |||||||||||
Retrieves the progress value for this snapshot.
| |||||||||||
Retrieves the unique identifier of this snapshot.
| |||||||||||
Indicates whether or not this snapshot has any changes pending that have not been uploaded to
the server.
| |||||||||||
Check to see if this object is valid for use.
| |||||||||||
[Expand]
Inherited Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
![]() | |||||||||||
![]() | |||||||||||
![]() | |||||||||||
![]() |
Parameters | |
---|---|
obj |
Object
|
Returns | |
---|---|
boolean |
Freeze a volatile representation into an immutable representation. Objects returned from this call are safe to cache.
Note that the output of freeze
may not be identical to the parent object, but should
be equal. In other words:
Freezable f1 = new Freezable();
Freezable f2 = f1.freeze();
f1 == f2 may not be true.
f1.equals(f2) will be true.
Returns | |
---|---|
SnapshotMetadata |
A concrete implementation of the data object. |
Retrieves the aspect ratio of the cover image for this snapshot, if any. This is the ratio of width to height, so a value > 1.0f indicates a landscape image while a value < 1.0f indicates a portrait image. If the snapshot has no cover image, this will return 0.0f.
Returns | |
---|---|
float |
The aspect ratio of the cover image, or 0.0f if no image is present. |
Retrieves an image URI that can be used to load the snapshot's cover image. Returns null if the snapshot has no cover image.
To retrieve the Image from theUri
, use ImageManager
.
Returns | |
---|---|
Uri |
A URI that can be used to load this snapshot's cover image, if one is present. |
Retrieves the description of this snapshot.
Returns | |
---|---|
String |
The description of this snapshot. |
Loads the snapshot description into the given CharArrayBuffer
.
Parameters | |
---|---|
dataOut |
CharArrayBuffer :
The buffer to load the data into.
|
Retrieves the name of the device that wrote this snapshot, if known.
Returns | |
---|---|
String |
The name of the device that wrote this snapshot, or null if not known. |
Retrieves the game associated with this snapshot.
Returns | |
---|---|
Game |
The associated game. |
Retrieves the last time this snapshot was modified, in millis since epoch.
Returns | |
---|---|
long |
The last modification time of this snapshot. |
Retrieves the player that owns this snapshot.
Returns | |
---|---|
Player |
The owning player. |
Retrieves the played time of this snapshot in milliseconds. This value is specified during
the update operation. If not known, returns PLAYED_TIME_UNKNOWN
.
Returns | |
---|---|
long |
The played time of this snapshot in milliseconds, or PLAYED_TIME_UNKNOWN if
not known.
|
Retrieves the progress value for this snapshot. Can be used to provide automatic conflict
resolution (see RESOLUTION_POLICY_HIGHEST_PROGRESS
). If not known, returns
PROGRESS_VALUE_UNKNOWN
.
Returns | |
---|---|
long |
Progress value for this snapshot, or PROGRESS_VALUE_UNKNOWN if not known.
|
Returns | |
---|---|
String |
Retrieves the unique identifier of this snapshot. This value can be passed to
open(GoogleApiClient, SnapshotMetadata)
to open the snapshot for modification.
This name should be unique within the scope of the application.
Returns | |
---|---|
String |
Unique identifier of this snapshot. |
Indicates whether or not this snapshot has any changes pending that have not been uploaded to the server. Once all changes have been flushed to the server, this will return false.
Returns | |
---|---|
boolean |
Whether or not this snapshot has any outstanding changes. |
Returns | |
---|---|
int |
Check to see if this object is valid for use. If the object is still volatile, this method
will indicate whether or not the object can be safely used. The output of a call to
freeze()
will always be valid.
Returns | |
---|---|
boolean |
whether or not the object is valid for use. |
Returns | |
---|---|
String |
Parameters | |
---|---|
out |
Parcel
|
flags |
int
|