| Known Indirect Subclasses |
Data interface for the metadata of a saved game.
| long | PLAYED_TIME_UNKNOWN | Constant indicating that the played time of a snapshot is unknown. |
| long | PROGRESS_VALUE_UNKNOWN | Constant indicating that the progress value of a snapshot is unknown. |
| abstract float |
getCoverImageAspectRatio()
Retrieves the aspect ratio of the cover image for this snapshot, if any.
|
| abstract Uri |
getCoverImageUri()
Retrieves an image URI that can be used to load the snapshot's cover image.
|
| abstract String |
getDescription()
Retrieves the description of this snapshot.
|
| abstract void |
getDescription(CharArrayBuffer
dataOut)
Loads the snapshot description into the given
CharArrayBuffer.
|
| abstract String |
getDeviceName()
Retrieves the name of the device that wrote this snapshot, if known.
|
| abstract Game |
getGame()
Retrieves the game associated with this snapshot.
|
| abstract long |
getLastModifiedTimestamp()
Retrieves the last time this snapshot was modified, in millis since epoch.
|
| abstract Player |
getOwner()
Retrieves the player that owns this snapshot.
|
| abstract long |
getPlayedTime()
Retrieves the played time of this snapshot in milliseconds.
|
| abstract long |
getProgressValue()
Retrieves the progress value for this snapshot.
|
| abstract String |
getSnapshotId()
Retrieves the ID of this snapshot.
|
| abstract String |
getUniqueName()
Retrieves the unique identifier of this snapshot.
|
| abstract boolean |
hasChangePending()
Indicates whether or not this snapshot has any changes pending that have not
been uploaded to the server.
|
Constant indicating that the played time of a snapshot is unknown.
Constant indicating that the progress value of a snapshot is unknown.
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.
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 the Uri, use
ImageManager.
Retrieves the description of this snapshot.
Loads the snapshot description into the given CharArrayBuffer.
| dataOut | The buffer to load the data into. |
|---|
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. This value is specified
during the update operation. If not known, returns
PLAYED_TIME_UNKNOWN.
PLAYED_TIME_UNKNOWN if not known.Retrieves the progress value for this snapshot. Can be used to provide automatic
conflict resolution (see
SnapshotsClient.RESOLUTION_POLICY_HIGHEST_PROGRESS). If not known, returns
PROGRESS_VALUE_UNKNOWN.
PROGRESS_VALUE_UNKNOWN if not known.Retrieves the ID of this snapshot.
Retrieves the unique identifier of this snapshot. This value can be passed to
SnapshotsClient.open(SnapshotMetadata) to open the snapshot for
modification.
This name should be unique within the scope of the application.
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.