API reference

FOvrDestination Struct

In Header file OVRPlatformModels.h
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 field FOvrDestination::ApiName, field FOvrDestination::DisplayName, field FOvrDestination::DeeplinkMessage and field FOvrDestination::ShareableUri link. Please refer to member data documentation for details.

Constructors

FOvrDestination ()
This is the default constructor for the struct, which initializes the ::ovrDestinationHandle and TOvrMessageHandlePtr to their default values.
Signature
FOvrDestination::FOvrDestination()
FOvrDestination ( OvrHandle , MessageHandlePtr )
Copying values from an OVR handle to the array, and the originating message to prevent the handle from being freed.
Signature
FOvrDestination::FOvrDestination(ovrDestinationHandle OvrHandle, TOvrMessageHandlePtr MessageHandlePtr)
Parameters
OvrHandle: ovrDestinationHandle
MessageHandlePtr: TOvrMessageHandlePtr

Fields

ApiName : FString
You can pass it into FOvrGroupPresenceOptions::DestinationApiName when calling UOvrRequestsBlueprintLibrary::GroupPresence_Set() to set this user's group presence.
Signature
FString FOvrDestination::ApiName
DeeplinkMessage : FString
The information that will be in field FOvrLaunchDetails::DeeplinkMessage when a user enters via a deeplink. Alternatively will be in field FOvrUser::PresenceDeeplinkMessage if the rich presence is set for the user.
Signature
FString FOvrDestination::DeeplinkMessage
DisplayName : FString
A displayable string of the destination name and it can be retrieved with field FOvrDestination::DisplayName.
Signature
FString FOvrDestination::DisplayName
ShareableUri : FString
A URI that allows the user to deeplink directly to this destination
Signature
FString FOvrDestination::ShareableUri

Member Functions

Clear ()
Setting all values to their defaults, effectively clearing the struct.
Signature
void FOvrDestination::Clear()
Returns
void
Update ( OvrHandle , MessageHandlePtr )
Updating values from an OVR handle to the array, and the originating message to prevent the handle from being freed.
Signature
void FOvrDestination::Update(ovrDestinationHandle OvrHandle, TOvrMessageHandlePtr MessageHandlePtr)
Parameters
OvrHandle: ovrDestinationHandle
MessageHandlePtr: TOvrMessageHandlePtr
Returns
void