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

Destination

Updated: Oct 30, 2025

Destination

interface Destination
The destination represents where the user would like to go to in the app. It’s usually associated with a travel or an invitation. Each destination has horizon.platform.richpresence.models.Destination.apiName, horizon.platform.richpresence.models.Destination.displayName, horizon.platform.richpresence.models.Destination.deeplinkMessage and horizon.platform.richpresence.models.Destination.shareableUri link. Please refer to member data documentation for details.

Properties

NameSummary
apiName
abstract val apiName: String
You can pass it into horizon.platform.grouppresence.options.GroupPresenceOptions.destinationApiName when calling horizon.platform.grouppresence.GroupPresence.set to set this user’s group presence.
deeplinkMessage
abstract val deeplinkMessage: String?
The information that will be in horizon.platform.applicationlifecycle.models.LaunchDetails.deeplinkMessage when a user enters via a deeplink. Alternatively will be in horizon.platform.users.models.User.presenceDeeplinkMessage if the rich presence is set for the user.
displayName
abstract val displayName: String
A displayable string of the destination name and it can be retrieved with horizon.platform.richpresence.models.Destination.displayName.
json
open val json: String
shareableUri
abstract val shareableUri: String?
A URI that allows the user to deeplink directly to this destination