Deeplink
Pass launch context and custom configuration to an N2I-streamed app through URL-encoded deeplinks and query parameters.
Overview
N2I supports starting your streamed app with a deeplink that carries custom query parameters. Pass context and configuration at launch time, such as PWA mode, the player's device type, IP address, or any other information your app needs.
This is facultative, only needed if your app needs to have some information from N2I frontend.
How it works
When a player launches your game through N2I, N2I opens it with the deeplink including all query parameters.
Your app decodes the deeplink, reads the query parameters, and uses them during initialization.
Supported parameters
| Parameter | Description |
|---|---|
pwa | Indicates whether the app was launched from a PWA or homescreen install. Possible values: true, false |
device | The player's device type. Possible values: desktop, ios, android. |
ip | The player's IPv4 address. |
| Custom | Any additional key-value pair your app requires. |
Example
The following deeplink passes PWA status, device type, IP address, and a custom data value to the app:
com.game.my://start?pwa=true&device=android&ip=1.2.3.4&data=my-value
At launch, the app decodes the deeplink and extracts the query parameters:
pwa=truedevice=androidip=1.2.3.4data=my-value