Please Select Your Location

Thailand
Australia
Österreich
België
Canada
Canada - Français
中国
Česká republika
Denmark
Deutschland
France
HongKong
Iceland
India
Ireland
Italia
日本
Korea
Latvija
Lietuva
Lëtzebuerg
Malaysia
Malta
Mexico
Nederland
New Zealand
Norge
Polska
Portugal
Russia
Saudi Arabia
Singapore
Southeast Asia
España
Suisse
Suomi
Sverige
台灣
Ukraine
United Kingdom
United States
Việt Nam
المملكة العربية السعودية (Arabic)

Function usage

IsReady()

void IsReady(StatusCallback callback)
Name Type Description
callback statusCallback Callback function

Call this function to initialize the Deeplink API.

GoToApp()

void GoToApp(StatusCallback2 callback, string viveportId, string launchData)
Name Type Description
callback statusCallback2 Callback function
viveportId string VIVEPORT ID
launchData string Launch data can be retrieved with GetAppLaunchData() .

Launches a title specified by VIVEPORT ID and passes launchData to the title from GetAppLaunchData() . launchData cannot be empty, but can accept other strings such as “NULL” or “NONE” if launch data is not available.

GoToApp()

void GoToApp(StatusCallback2 callback, string viveportId, string launchData, string branchName)
Name Type Description
callback statusCallback2 Callback function
viveportId string VIVEPORT ID
launchData string From GetAppLaunchData()
branchName string Target branch name, possible values include “PROD” and “BETA”

Launches a title specified by VIVEPORT ID, and optionally, passes launchData to the title from GetAppLaunchData() . launchData cannot be empty, but can accept other strings such as “NULL” or “NONE” if launch data is not available. Branch names can be specified for cases where more than one version of the same title may be run at the same time, such as beta and production versions of the title.

GoToStore()

void GoToStore(StatusCallback2 callback, string viveportId)
Name Type Description
callback statusCallback2 Callback function
viveportId string VIVEPORT ID

Launch the VIVEPORT store and go to a specific page specified by the VIVEPORT ID . To go to the VIVEPORT store main page, use an empty string for viveportId .

GoToAppOrGoToStore()

void GoToAppOrGoToStore(StatusCallback2 callback, string viveportId, string launchData)
Name Type Description
callback statusCallback2 Callback function
viveportId string VIVEPORT ID
launchData string From GetAppLaunchData()

This API combines the features of GoToStore and GoToApp . It detects if the end user has purchased/installed the title. If the user already has the title in question, it launches. If not, the store page for the title will launch.

GetAppLaunchData()

string GetAppLaunchData()

Call this function to get launch data for a title that has been launched using GoToApp or GoToAppOrGoToStore . This will allow you to get the launchdata string so that the correct content can be shown in the launched title.

For example: Title A launches Title B using GoToApp() , and passes “Start in level 2” as launchData to GoToApp() . Title B can call GetAppLaunchData() so that Title B knows to start the game at level 2.