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

ApplicationOptions Interface

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

Signature

interface ApplicationOptions

Properties

deeplinkMessage : String
[Get]
A message to be passed to a launched app, which can be retrieved with LaunchDetails.deeplinkMessage.
Signature 
abstract val deeplinkMessage: String
destinationApiName : String
[Get]
If provided, the intended destination to be passed to the launched app, which can be retrieved with LaunchDetails.destinationApiName.
Signature 
abstract val destinationApiName: String
lobbySessionId : String
[Get]
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 LaunchDetails.lobbySessionId.
Signature 
abstract val lobbySessionId: String
matchSessionId : String
[Get]
If provided, the intended instance of the destination that a user should be launched into, which can be retrieved with LaunchDetails.matchSessionId.
Signature 
abstract val matchSessionId: String
roomId : String?
[Get]
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.
Signature 
abstract val roomId: String?

Companion Object

Companion Object Functions

builder ()
Signature 
fun builder(): ApplicationOptions.Builder
Returns
ApplicationOptions.Builder

Inner Interface

Builder Interface

Signature

interface Builder

Functions

build ()
Signature 
abstract fun build(): ApplicationOptions
Returns
ApplicationOptions
withDeeplinkMessage ( deeplinkMessage )
Signature 
abstract fun withDeeplinkMessage(deeplinkMessage: String): ApplicationOptions.Builder
Parameters
deeplinkMessage: String
Returns
ApplicationOptions.Builder
withDestinationApiName ( destinationApiName )
Signature 
abstract fun withDestinationApiName(destinationApiName: String): ApplicationOptions.Builder
Parameters
destinationApiName: String
Returns
ApplicationOptions.Builder
withLobbySessionId ( lobbySessionId )
Signature 
abstract fun withLobbySessionId(lobbySessionId: String): ApplicationOptions.Builder
Parameters
lobbySessionId: String
Returns
ApplicationOptions.Builder
withMatchSessionId ( matchSessionId )
Signature 
abstract fun withMatchSessionId(matchSessionId: String): ApplicationOptions.Builder
Parameters
matchSessionId: String
Returns
ApplicationOptions.Builder
withRoomId ( roomId )
Signature 
abstract fun withRoomId(roomId: String?): ApplicationOptions.Builder
Parameters
roomId: String?
Returns
ApplicationOptions.Builder
Did you find this page helpful?
Nav Logo
Virtual reality / Meta Horizon
Virtual reality / Meta Horizon
Virtual reality / Meta Horizon
English (US)
© 2026 Meta