Hide

SnapshotMetadataEntity

public final class SnapshotMetadataEntity extends Object
implements SnapshotMetadata Parcelable
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.

Inherited Constant Summary

Field Summary

public static final Creator<SnapshotMetadataEntity> CREATOR

Public Method Summary

int
boolean
equals(Object obj)
SnapshotMetadata
freeze()
float
Uri
String
void
Game
long
Player
long
long
String
String
boolean
int
boolean
String
void
writeToParcel(Parcel out, int flags)

Fields

public static final Creator<SnapshotMetadataEntity> CREATOR

Public Methods

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.
 
 

Returns
  • 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.

Returns
  • The aspect ratio of the cover image, or 0.0f if no image is present.

public Uri getCoverImageUri ()

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.

Returns
  • A URI that can be used to load this snapshot's cover image, if one is present.

public String getDescription ()

Retrieves the description of this snapshot.

Returns
  • The description of this snapshot.

public void getDescription (CharArrayBuffer dataOut)

Loads the snapshot description into the given CharArrayBuffer.

Parameters
dataOut The buffer to load the data into.

public Game getGame ()

Retrieves the game associated with this snapshot.

Returns
  • The associated game.

public long getLastModifiedTimestamp ()

Retrieves the last time this snapshot was modified, in millis since epoch.

Returns
  • The last modification time of this snapshot.

public Player getOwner ()

Retrieves the player that owns this snapshot.

Returns
  • The owning player.

public long getPlayedTime ()

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

public long getProgressValue ()

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

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.

Returns
  • 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.

Returns
  • 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.

Returns
  • whether or not the object is valid for use.

public String toString ()

public void writeToParcel (Parcel out, int flags)