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

LaunchDetails

Updated: Jul 24, 2025

LaunchDetails

interface LaunchDetails
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 horizon.platform.application_lifecycle.ApplicationLifecycle.getLaunchDetails.

Properties

NameSummary
deeplinkMessage
abstract val deeplinkMessage: String?
An opaque string provided by the developer to help them deeplink to content on app startup.
destinationApiName
abstract val destinationApiName: String?
If provided, the intended destination the user would like to go to
json
open val json: String
launchSource
abstract val launchSource: String?
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.
launchType
abstract val launchType: LaunchType
A horizon.platform.application_lifecycle.enums.LaunchType that defines the different ways in which an application can be launched. horizon.platform.application_lifecycle.enums.LaunchType.normal - Normal launch from the user’s library. horizon.platform.application_lifecycle.enums.LaunchType.invite - Launch from the user accepting an invite. horizon.platform.application_lifecycle.enums.LaunchType.deeplink - Launched from a deeplink. This flow is typically kicked off from horizon.platform.application.Application.launchOtherApp
lobbySessionId
abstract val lobbySessionId: String?
If provided, the intended lobby the user would like to be in
matchSessionId
abstract val matchSessionId: String?
If provided, the intended session the user would like to be in
trackingId
abstract val trackingId: String?
A unique identifier to keep track of a user going through the deeplinking flow
users
abstract val users: List<User>?
If provided, the intended users the user would like to be with
Did you find this page helpful?
Thumbs up icon
Thumbs down icon