EventsClient

AI-generated Key Takeaways

• EventsClient is a client used to interact with events functionality.

• The increment method increments an event by a specified amount.

• The load method asynchronously loads event data for the currently signed-in player.

• The loadByIds method asynchronously loads event data for specified event IDs.

public interface EventsClient

A client to interact with events functionality.

Public Method Summary

abstract void	increment(String eventId, int incrementAmount) Increments an event specified by eventId by the given number of steps.
abstract Task<AnnotatedData<EventBuffer>>	load(boolean forceReload) Returns a Task which asynchronously loads an annotated EventBuffer that represents the event data for the currently signed-in player.
abstract Task<AnnotatedData<EventBuffer>>	loadByIds(boolean forceReload, String... eventIds) Returns a Task which asynchronously loads an annotated EventBuffer that represents the event data for the specified event IDs.

Public Methods

public abstract void increment (String eventId, int incrementAmount)

Increments an event specified by eventId by the given number of steps.

This is the fire-and-forget API. Event increments are cached locally and flushed to the server in batches.

Parameters

eventId	The event ID to increment.
incrementAmount	The amount increment by. Must be greater than or equal to 0.

public abstract Task<AnnotatedData<EventBuffer>> load (boolean forceReload)

Returns a Task which asynchronously loads an annotated EventBuffer that represents the event data for the currently signed-in player.

AbstractDataBuffer.release() should be called to release resources after usage.

Parameters

forceReload	If true, this call will clear any locally cached data and attempt to fetch the latest data from the server. This would commonly be used for something like a user-initiated refresh. Normally, this should be set to false to gain advantages of data caching.

public abstract Task<AnnotatedData<EventBuffer>> loadByIds (boolean forceReload, String... eventIds)

Returns a Task which asynchronously loads an annotated EventBuffer that represents the event data for the specified event IDs.

AbstractDataBuffer.release() should be called to release resources after usage.

Parameters

forceReload	If true, this call will clear any locally cached data and attempt to fetch the latest data from the server. This would commonly be used for something like a user-initiated refresh. Normally, this should be set to false to gain advantages of data caching.
eventIds	The IDs of the events to load.