Kind: global class
-
SDK
-
.init(options) ⇒
Response.Init
-
.setResult(options) ⇒
Response.Result
-
.getRanking(options) ⇒
Response.Ranking
-
.setResultAndGetRanking(resultOptions, rankingOptions) ⇒
Response.ResultAndRanking
-
.quit() ⇒
void
-
.getStats(options) ⇒
Response.Stats
-
.init(options) ⇒
Initializes the SDK with the provided options. This should be called before or during startup of the extension in order to retrieve necessary information about the user, language, and more.
Kind: instance method of SDK
Param | Type | Description |
---|---|---|
options | Options.Init |
The initialization options. |
To be called after each session. Grants reward points and writes the achieved score to the database.
Kind: instance method of SDK
Param | Type | Description |
---|---|---|
options | Options.Result |
The result options. |
Retrieve the ranking for the provided extensionName and the attached options.
Kind: instance method of SDK
Param | Type | Description |
---|---|---|
options | Options.Ranking |
The ranking options. |
Helper to set result and fetch ranking in one simple step.
Kind: instance method of SDK
Param | Type | Description |
---|---|---|
resultOptions | Options.Result |
The result options. |
rankingOptions | Options.Ranking |
The ranking options. |
Redirects to the specified quitUrl
.
Kind: instance method of SDK
Gets stats about the game.
Kind: instance method of SDK
Param | Type | Description |
---|---|---|
options | Options.Stats |
The stats options. |
JtiExtension : SDK
Singleton instance of the SDK.
This instance is created and exported as JtiExtension
. It ensures that
only one instance of the SDK
class exists throughout the application.
Kind: global constant
Singleton:
© 2024 Sensory-Minds GmbH