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.
Inherited Constant Summary
|public static final Creator<SnapshotMetadataEntity>||CREATOR|
Public Method Summary
public int describeContents ()
public boolean equals (Object obj)
public SnapshotMetadata freeze ()
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.
- A concrete implementation of the data object.
public float getCoverImageAspectRatio ()
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.
- The aspect ratio of the cover image, or 0.0f if no image is present.
public Uri getCoverImageUri ()
public String getDescription ()
Retrieves the description of this snapshot.
- The description of this snapshot.
public void getDescription (CharArrayBuffer dataOut)
Loads the snapshot description into the given
|dataOut||The buffer to load the data into.|
public String getDeviceName ()
Retrieves the name of the device that wrote this snapshot, if known.
- The name of the device that wrote this snapshot, or null if not known.
public Game getGame ()
Retrieves the game associated with this snapshot.
- The associated game.
public long getLastModifiedTimestamp ()
Retrieves the last time this snapshot was modified, in millis since epoch.
- The last modification time of this snapshot.
public Player getOwner ()
Retrieves the player that owns this snapshot.
- The owning player.
public long getPlayedTime ()
public long getProgressValue ()
public String getSnapshotId ()
public String getUniqueName ()
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.
- Unique identifier of this snapshot.
public boolean hasChangePending ()
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.
- Whether or not this snapshot has any outstanding changes.
public int hashCode ()
public boolean isDataValid ()
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.
- whether or not the object is valid for use.