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

Destination Interface

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 Destination.apiName, Destination.displayName, Destination.deeplinkMessage and Destination.shareableUri link. Please refer to member data documentation for details.

Signature

interface Destination

Properties

apiName : String
[Get]
You can pass it into GroupPresenceOptions.destinationApiName when calling GroupPresence.set to set this user's group presence.
Signature 
abstract val apiName: String
deeplinkMessage : String?
[Get]
The information that will be in LaunchDetails.deeplinkMessage when a user enters via a deeplink. Alternatively will be in User.presenceDeeplinkMessage if the rich presence is set for the user.
Signature 
abstract val deeplinkMessage: String?
displayName : String
[Get]
A displayable string of the destination name and it can be retrieved with Destination.displayName.
Signature 
abstract val displayName: String
shareableUri : String?
[Get]
A URI that allows the user to deeplink directly to this destination
Signature 
abstract val shareableUri: String?
Did you find this page helpful?
Nav Logo
Virtual reality / Meta Horizon
Virtual reality / Meta Horizon
Virtual reality / Meta Horizon
English (US)
© 2026 Meta