This version (v0.7) has not been published to npm yet.
Skip to content

Reference / @getenginex/sdk-igaming / GameLaunch

GameLaunch ​

Game opened by CasinoApi.launchGame.

Sensitive: gameUrl carries the player's game session token. Use it only to open the game (as GameLaunch.launchTarget says) and never log it to logs, analytics, error tracking, nor store it.

Properties ​

expiresAt? ​

optional expiresAt?: string

Expiry of the game URL, ISO 8601 (UTC), when the provider reports one: open the game before it.


gameUrl ​

gameUrl: string

Game URL, with the game session token — do not log it. It may be absolute or relative to the gateway, depending on the provider; it is never empty (a response without a URL is VALIDATION_ERROR).


launchTarget ​

launchTarget: LaunchTarget

How to open gameUrl: some providers refuse to run inside an iframe and need redirect or new_tab. A response without it (an older gateway, or a custom mock) arrives as iframe, what the SDK documented before the gateway sent this field.


providerCode? ​

optional providerCode?: string

Code of the game's provider (e.g. pragmatic-play), as the gateway sends it; absent when it does not.


sessionId ​

sessionId: string

Game session id (the same as GameSession.id).