Summary: Inherited Constants | Fields | Methods | Inherited Methods | [Expand All]
public final class

# SnapshotMetadataEntity

extends Object
implements SafeParcelable SnapshotMetadata

java.lang.Object
↳ | com.google.android.gms.games.snapshot.SnapshotMetadataEntity

## Class Overview

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.

## Summary

[Expand] Inherited Constants
From interface com.google.android.gms.common.internal.safeparcel.SafeParcelable
String | NULL |
From interface com.google.android.gms.games.snapshot.SnapshotMetadata
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.
From interface android.os.Parcelable
int | CONTENTS_FILE_DESCRIPTOR |
int | PARCELABLE_WRITE_RETURN_VALUE |

Fields
public static final Creator<SnapshotMetadataEntity> | CREATOR |

Public Methods
boolean | equals(Object obj)
SnapshotMetadata | freeze() Freeze a volatile representation into an immutable representation.
float | getCoverImageAspectRatio() Retrieves the aspect ratio of the cover image for this snapshot, if any.
Uri | getCoverImageUri() Retrieves an image URI that can be used to load the snapshot's cover image.
String | getDescription() Retrieves the description of this snapshot.
void | getDescription(CharArrayBuffer dataOut) Loads the snapshot description into the given `CharArrayBuffer`.
String | getDeviceName() Retrieves the name of the device that wrote this snapshot, if known.
Game | getGame() Retrieves the game associated with this snapshot.
long | getLastModifiedTimestamp() Retrieves the last time this snapshot was modified, in millis since epoch.
Player | getOwner() Retrieves the player that owns this snapshot.
long | getPlayedTime() Retrieves the played time of this snapshot in milliseconds.
long | getProgressValue() Retrieves the progress value for this snapshot.
String | getSnapshotId()
String | getUniqueName() Retrieves the unique identifier of this snapshot.
boolean | hasChangePending() Indicates whether or not this snapshot has any changes pending that have not been uploaded to the server.
int | hashCode()
boolean | isDataValid() Check to see if this object is valid for use.
String | toString()
void | writeToParcel(Parcel out, int flags)

[Expand] Inherited Methods
From class java.lang.Object
Object | clone()
boolean | equals(Object arg0)
void | finalize()
final Class<?> | getClass()
int | hashCode()
final void | notify()
final void | notifyAll()
String | toString()
final void | wait(long arg0, int arg1)
final void | wait(long arg0)
final void | wait()
From interface com.google.android.gms.games.snapshot.SnapshotMetadata
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 | 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.
From interface android.os.Parcelable
abstract int | describeContents()
abstract void | writeToParcel(Parcel arg0, int arg1)
From interface com.google.android.gms.common.data.Freezable
abstract SnapshotMetadata | freeze() Freeze a volatile representation into an immutable representation.
abstract boolean | isDataValid() Check to see if this object is valid for use.

## Fields

#### public static final Creator<SnapshotMetadataEntity> CREATOR

## Public Methods

#### 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 String getDeviceName ()

Retrieves the name of the device that wrote this snapshot, if known.

##### Returns

- The name of the device that wrote this snapshot, or null if not known.

#### 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

- The played time of this snapshot in milliseconds, or `PLAYED_TIME_UNKNOWN` if not known.

#### 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

- Progress value for this snapshot, or `PROGRESS_VALUE_UNKNOWN` if not known.

#### 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)