host.anzo.eossdk.eos.sdk

Class EOS_ProgressionSnapshot_Interface

java.lang.Object

com.sun.jna.PointerType

host.anzo.eossdk.eos.sdk.EOS_ProgressionSnapshot_Interface

All Implemented Interfaces:

com.sun.jna.NativeMapped

public class EOS_ProgressionSnapshot_Interface
extends com.sun.jna.PointerType

Progression Snapshots allow you to store player specific game state.

BeginSnapshot must be called to obtain a handle for a given player. AddProgression allows you to add Key/Value pairs that represent some state for that player in the game. SubmitSnapshot sends all the progression data you have added (via AddProgression) to the service. EndSnapshot cleans up internal resources allocated for that snapshot. DeleteSnapshot wipes out all data associated with a particular player.

Since:

8/22/2023

See Also:

EOS_Platform_Interface.getProgressionSnapshotInterface()

Constructor Summary

Constructors

Constructor and Description
EOS_ProgressionSnapshot_Interface()
EOS_ProgressionSnapshot_Interface(com.sun.jna.Pointer address)

Method Summary

Modifier and Type	Method and Description
EOS_EResult	addProgression(EOS_ProgressionSnapshot_AddProgressionOptions options) Stores a Key/Value pair in memory for a given snapshot.
int	beginSnapshot(EOS_ProgressionSnapshot_BeginSnapshotOptions options) Creates a new progression-snapshot resource for a given user.
void	deleteSnapshot(EOS_ProgressionSnapshot_DeleteSnapshotOptions options, com.sun.jna.Pointer clientData, EOS_ProgressionSnapshot_OnDeleteSnapshotCallback completionDelegate) Wipes out all progression data for the given user from the service.
EOS_EResult	endSnapshot(EOS_ProgressionSnapshot_EndSnapshotOptions options) Cleans up and releases resources associated with the given progression snapshot identifier.
void	submitSnapshot(EOS_ProgressionSnapshot_SubmitSnapshotOptions options, com.sun.jna.Pointer clientData, EOS_ProgressionSnapshot_OnSubmitSnapshotCallback completionDelegate) Saves the previously added Key/Value pairs of a given Snapshot to the service.

Methods inherited from class com.sun.jna.PointerType

equals, fromNative, getPointer, hashCode, nativeType, setPointer, toNative, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

EOS_ProgressionSnapshot_Interface

public EOS_ProgressionSnapshot_Interface(com.sun.jna.Pointer address)

EOS_ProgressionSnapshot_Interface

public EOS_ProgressionSnapshot_Interface()

Method Detail

beginSnapshot

public int beginSnapshot(EOS_ProgressionSnapshot_BeginSnapshotOptions options)
                  throws EOSException

Creates a new progression-snapshot resource for a given user.

Parameters:

options - Object containing properties that identifies the PUID this Snapshot will belong to.

Returns:

A progression-snapshot identifier output parameter. Use that identifier to reference the snapshot in the other APIs.

Throws:

EOSProgressionSnapshotSnapshotIdUnavailableException - when no IDs are available. This is irrecoverable state.

EOSException

addProgression

public EOS_EResult addProgression(EOS_ProgressionSnapshot_AddProgressionOptions options)

Stores a Key/Value pair in memory for a given snapshot. If multiple calls happen with the same key, the last invocation wins, overwriting the previous value for that given key.

The order in which the Key/Value pairs are added is stored as is for later retrieval/display. Ideally, you would make multiple calls to AddProgression() followed by a single call to SubmitSnapshot().

Parameters:

options - Object containing properties that identify the snapshot and the Key/Value pair to add.

Returns:

EOS_EResult.EOS_Success when successful; otherwise, EOS_EResult.EOS_NotFound

submitSnapshot

public void submitSnapshot(EOS_ProgressionSnapshot_SubmitSnapshotOptions options,
                           com.sun.jna.Pointer clientData,
                           EOS_ProgressionSnapshot_OnSubmitSnapshotCallback completionDelegate)

Saves the previously added Key/Value pairs of a given Snapshot to the service.

Note: This will overwrite any prior progression data stored with the service that's associated with the user.

Parameters:

options - Object containing properties that identify the snapshot to submit.

clientData - Optional context that is passed back in the completion delegate.

completionDelegate - A callback that is fired when the operation completes, either successfully or in error.

endSnapshot

public EOS_EResult endSnapshot(EOS_ProgressionSnapshot_EndSnapshotOptions options)

Cleans up and releases resources associated with the given progression snapshot identifier.

Parameters:

options - Object containing properties that identify the snapshot to end.

Returns:

EOS_EResult.EOS_Success when successful; otherwise, EOS_EResult.EOS_NotFound

deleteSnapshot

public void deleteSnapshot(EOS_ProgressionSnapshot_DeleteSnapshotOptions options,
                           com.sun.jna.Pointer clientData,
                           EOS_ProgressionSnapshot_OnDeleteSnapshotCallback completionDelegate)

Wipes out all progression data for the given user from the service. However, any previous progression data that haven't been submitted yet are retained.

Parameters:

options - Object containing properties that identify the PUID whose snapshot data should be deleted.

clientData - Optional context that is passed back in the completion delegate.

completionDelegate - A callback that is fired when the operation completes, either successfully or in error.