Beamable SDK
Public Member Functions | List of all members
Beamable.Common.Api.Events.IEventsApi Interface Reference
Inheritance diagram for Beamable.Common.Api.Events.IEventsApi:
Inheritance graph
[legend]
Collaboration diagram for Beamable.Common.Api.Events.IEventsApi:
Collaboration graph
[legend]

Public Member Functions

Promise< EventClaimResponseClaim (string eventId)
 
Promise< UnitSetScore (string eventId, double score, bool incremental=false, IDictionary< string, object > stats=null)
 Submit a score for the current player. Note that this is only allowed if the event has the write_self permission. More...
 
- Public Member Functions inherited from Beamable.Common.Api.ISupportsGet< EventsGetResponse >
Promise< TData > GetCurrent (string scope="")
 

Member Function Documentation

◆ SetScore()

Promise<Unit> Beamable.Common.Api.Events.IEventsApi.SetScore ( string  eventId,
double  score,
bool  incremental = false,
IDictionary< string, object >  stats = null 
)

Submit a score for the current player. Note that this is only allowed if the event has the write_self permission.

Parameters
eventIdFull ID of the event, including timestamp suffix.
scoreThe score to submit (or score delta if incremental).
incrementalIf incremental is true, add to the existing score, otherwise set it absolutely.
statsOptional key-value mapping of stats to apply to the score.
Returns
Promise indicating success or failure.

Implemented in Beamable.Common.Api.Events.AbsEventsApi.


The documentation for this interface was generated from the following file: