API reference
API reference
Select your platform
No SDKs available
No versions available

ApplicationOptions

Updated: Oct 30, 2025

ApplicationOptions

interface ApplicationOptions
The Application option contains additional configuration to be passed in to horizon.platform.application.Application.launchOtherApp and horizon.platform.application.Application.installAppUpdateAndRelaunch. It contains 5 fields horizon.platform.application.options.ApplicationOptions.deeplinkMessage, horizon.platform.application.options.ApplicationOptions.destinationApiName, horizon.platform.application.options.ApplicationOptions.lobbySessionId, horizon.platform.application.options.ApplicationOptions.matchSessionId and horizon.platform.application.options.ApplicationOptions.roomId.

Types

NameSummary
interface Builder
Companion
object Companion

Properties

NameSummary
deeplinkMessage
abstract val deeplinkMessage: String
A message to be passed to a launched app, which can be retrieved with horizon.platform.applicationlifecycle.models.LaunchDetails.deeplinkMessage.
destinationApiName
abstract val destinationApiName: String
If provided, the intended destination to be passed to the launched app, which can be retrieved with horizon.platform.applicationlifecycle.models.LaunchDetails.destinationApiName.
lobbySessionId
abstract val lobbySessionId: String
If provided, the intended lobby where the launched app should take the user. All users with the same lobby_session_id should end up grouped together in the launched app, which can be retrieved with horizon.platform.applicationlifecycle.models.LaunchDetails.lobbySessionId.
matchSessionId
abstract val matchSessionId: String
If provided, the intended instance of the destination that a user should be launched into, which can be retrieved with horizon.platform.applicationlifecycle.models.LaunchDetails.matchSessionId.
roomId
abstract val roomId: String?
DeprecatedIf provided, the intended room where the launched app should take the user (all users heading to the same place should have the same value). A room_id of 0 is INVALID.

Companion

object Companion

Functions

NameSummary
builder