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

LaunchDetails Interface

Details about the launch of the appplication. It can be used to check if your app is being launched using App to App Travel. It can be retrieved using ApplicationLifecycle.getLaunchDetails.

Signature

interface LaunchDetails

Properties

deeplinkMessage : String?
[Get]
An opaque string provided by the developer to help them deeplink to content on app startup.
Signature 
abstract val deeplinkMessage: String?
destinationApiName : String?
[Get]
If provided, the intended destination the user would like to go to
Signature 
abstract val destinationApiName: String?
launchSource : String?
[Get]
A string typically used to distinguish where the deeplink came from. For instance, a DEEPLINK launch type could be coming from events or rich presence.
Signature 
abstract val launchSource: String?
launchType : LaunchType
[Get]
A LaunchType that defines the different ways in which an application can be launched. LaunchType.Normal - Normal launch from the user's library. LaunchType.Invite - Launch from the user accepting an invite. LaunchType.Deeplink - Launched from a deeplink. This flow is typically kicked off from Application.launchOtherApp
Signature 
abstract val launchType: LaunchType
lobbySessionId : String?
[Get]
If provided, the intended lobby the user would like to be in
Signature 
abstract val lobbySessionId: String?
matchSessionId : String?
[Get]
If provided, the intended session the user would like to be in
Signature 
abstract val matchSessionId: String?
trackingId : String?
[Get]
A unique identifier to keep track of a user going through the deeplinking flow
Signature 
abstract val trackingId: String?
users : List?
[Get]
If provided, the intended users the user would like to be with
Signature 
abstract val users: List<User>?
Did you find this page helpful?
Nav Logo
Virtual reality / Meta Horizon
Virtual reality / Meta Horizon
Virtual reality / Meta Horizon
English (US)
© 2026 Meta