Snapshot

AI-generated Key Takeaways

• Snapshot is a data interface representing a saved game, including metadata and game content.

• It provides methods to access the snapshot's metadata (getMetadata()) and content (getSnapshotContents()).

• SnapshotContents allows updating the snapshot data, but it might be null if the snapshot wasn't opened for writing.

• The interface inherits methods for freezing data (freeze()), checking data validity (isDataValid()), and parceling for inter-process communication (describeContents(), writeToParcel()).

public interface Snapshot implements Freezable<Snapshot> Parcelable

Known Indirect Subclasses SnapshotEntity SnapshotEntity Data object representing the data for a saved game.

Data interface for a representation of a saved game. This includes both the metadata and the actual game content.

Inherited Constant Summary

From interface android.os.Parcelable

int	CONTENTS_FILE_DESCRIPTOR
int	PARCELABLE_WRITE_RETURN_VALUE

Public Method Summary

abstract SnapshotMetadata	getMetadata() Retrieves the metadata for this snapshot.
abstract SnapshotContents	getSnapshotContents() Retrieve the SnapshotContents associated with this snapshot.

Inherited Method Summary

From interface com.google.android.gms.common.data.Freezable

abstract Snapshot	freeze()
abstract boolean	isDataValid()

From interface android.os.Parcelable

abstract int	describeContents()
abstract void	writeToParcel(Parcel arg0, int arg1)

Public Methods

public abstract SnapshotMetadata getMetadata ()

Retrieves the metadata for this snapshot.

Returns

• The SnapshotMetadata associated with this snapshot.

public abstract SnapshotContents getSnapshotContents ()

Retrieve the SnapshotContents associated with this snapshot. This object can be used to update the data of a snapshot. Note that this will return null if this snapshot was not obtained via SnapshotsClient.open(SnapshotMetadata).

Returns

• The SnapshotContents for this snapshot, or null if the snapshot is not opened.