Inheritance diagram for Beamable.Common.Api.Events.IEventsApi:

[legend]

Collaboration diagram for Beamable.Common.Api.Events.IEventsApi:

Public Member Functions
Promise< EventClaimResponse >	Claim (string eventId)
	Claim the earned rewards for an event. This method will throw an exception if the player has never submitted a score to the event. More...

Promise< Unit >	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. More...

Public Member Functions inherited from Beamable.Common.Api.ISupportsGet< EventsGetResponse >
Promise< TData >	GetCurrent (string scope="")
	Manually fetch the available data. If the server hasn't delivered a new update, this method will not return the absolute latest data unless you pass forceRefresh as true. More...

Member Function Documentation

◆ Claim()

Promise< EventClaimResponse > Beamable.Common.Api.Events.IEventsApi.Claim ( string eventId )

Claim the earned rewards for an event. This method will throw an exception if the player has never submitted a score to the event.

Parameters

eventId The runtime id of the event you'd like to claim

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

eventId	Full ID of the event, including timestamp suffix.
score	The score to submit (or score delta if incremental).
incremental	If incremental is true, add to the existing score, otherwise set it absolutely.
stats	Optional key-value mapping of stats to apply to the score.

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