API reference

OVR_LaunchDetails.h File

Typedefs

struct ovrLaunchDetails * ovrLaunchDetailsHandle

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

Functions

const char * ovr_LaunchDetails_GetDeeplinkMessage

( const ovrLaunchDetailsHandle obj )

An opaque string provided by the developer to help them deeplink to content on app startup.

const char * ovr_LaunchDetails_GetDestinationApiName

( const ovrLaunchDetailsHandle obj )

If provided, the intended destination the user would like to go to.

const char * ovr_LaunchDetails_GetLaunchSource

( const ovrLaunchDetailsHandle obj )

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.

ovrLaunchType ovr_LaunchDetails_GetLaunchType

( const ovrLaunchDetailsHandle obj )

A ovrLaunchType_LaunchType that defines the different ways in which an application can be launched. ovrLaunchType_Normal - Normal launch from the user's library. ovrLaunchType_Invite - Launch from the user accepting an invite. ovrLaunchType_Deeplink - Launched from a deeplink. This flow is typically kicked off from ovr_Application_LaunchOtherApp()

const char * ovr_LaunchDetails_GetLobbySessionID

( const ovrLaunchDetailsHandle obj )

If provided, the intended lobby the user would like to be in.

const char * ovr_LaunchDetails_GetMatchSessionID

( const ovrLaunchDetailsHandle obj )

If provided, the intended session the user would like to be in.

const char * ovr_LaunchDetails_GetTrackingID

( const ovrLaunchDetailsHandle obj )

A unique identifier to keep track of a user going through the deeplinking flow

ovrUserArrayHandle ovr_LaunchDetails_GetUsers

( const ovrLaunchDetailsHandle obj )

If provided, the intended users the user would like to be with This method may return null. This indicates that the value is not present or that the curent app or user is not permitted to access it.