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

FOvrLaunchDetails Struct

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().

Constructors

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

Fields

DeeplinkMessage : FString
An opaque string provided by the developer to help them deeplink to content on app startup.
Signature
FString FOvrLaunchDetails::DeeplinkMessage
DestinationApiName : FString
If provided, the intended destination the user would like to go to
Signature
FString FOvrLaunchDetails::DestinationApiName
LaunchSource : FString
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
FString FOvrLaunchDetails::LaunchSource
LaunchType : EOvrLaunchType
A EOvrLaunchType that defines the different ways in which an application can be launched. EOvrLaunchType::Normal - Normal launch from the user's library. EOvrLaunchType::Invite - Launch from the user accepting an invite. EOvrLaunchType::Deeplink - Launched from a deeplink. This flow is typically kicked off from Application_LaunchOtherApp()
Signature
EOvrLaunchType FOvrLaunchDetails::LaunchType
LobbySessionID : FString
If provided, the intended lobby the user would like to be in
Signature
FString FOvrLaunchDetails::LobbySessionID
MatchSessionID : FString
If provided, the intended session the user would like to be in
Signature
FString FOvrLaunchDetails::MatchSessionID
TrackingID : FString
A unique identifier to keep track of a user going through the deeplinking flow
Signature
FString FOvrLaunchDetails::TrackingID
If provided, the intended users the user would like to be with
Signature
FOvrUserPages FOvrLaunchDetails::Users

Member Functions

Clear ()
Setting all values to their defaults, effectively clearing the struct.
Signature
void FOvrLaunchDetails::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 FOvrLaunchDetails::Update(ovrLaunchDetailsHandle OvrHandle, TOvrMessageHandlePtr MessageHandlePtr)
Parameters
MessageHandlePtr: TOvrMessageHandlePtr
Returns
void