API reference

OVR_User.h File

Typedefs

struct ovrUser * ovrUserHandle

This is the class that represents the individual users who use your application. Use the User object to retrieve information about your users, help them interact with your application, and customize their experience. You can query for information about a particular user using their user id, ovr_User_GetID(). To learn more, read our docs about users. Note: You must complete a Data Use Checkup(DUC) in order to gain access to user platform features. Read more about DUC here.

Functions

const char * ovr_User_GetDisplayName

( const ovrUserHandle obj )

A potentially non unique displayable name chosen by the ovrUserHandle. Could also be the same as the oculus_ID. This is often the name shown to other users.

ovrID ovr_User_GetID

( const ovrUserHandle obj )

The ID of the user, ovr_User_GetID(). This is a unique value for every individual ovrUserHandle.

const char * ovr_User_GetImageUrl

( const ovrUserHandle obj )

The url of the profile picture that is chosen by the user. Retrieve this url by using ovr_User_GetImageUrl().

ovrManagedInfoHandle ovr_User_GetManagedInfo

( const ovrUserHandle obj )

Managed account info, ovrManagedInfoHandle, for the user which contains further metadata that is only available if the user is a Meta Managed Account(MMA). There must be user consent via dialog during installation, your app must have DUC enabled, and the app must be admin-approved. 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.

const char * ovr_User_GetOculusID

( const ovrUserHandle obj )

The oculus ID of the ovrUserHandle. This is used across the developer dashboard and is unique to oculus.

const char * ovr_User_GetPresence

( const ovrUserHandle obj )

Human readable string of what the user is currently doing. Not intended to be parsed as it might change at anytime or be translated.

const char * ovr_User_GetPresenceDeeplinkMessage

( const ovrUserHandle obj )

Intended to be parsed and used to deeplink to parts of the app. Read more about deeplinking here.

const char * ovr_User_GetPresenceDestinationApiName

( const ovrUserHandle obj )

If provided, this is the unique API Name that refers to the ovrDestinationHandle this user is currently at in the app. Read more about destinations here

const char * ovr_User_GetPresenceLobbySessionId

( const ovrUserHandle obj )

If provided, the lobby session this user is currently at in the application. If the ApplicationInvite is generated from rich presence, the lobby session id will be auto populated by calling ovr_User_GetPresenceLobbySessionId() from the inviters' viewer context.

const char * ovr_User_GetPresenceMatchSessionId

( const ovrUserHandle obj )

If provided, the match session this user is currently at in the application. If the ApplicationInvite is generated from rich presence, the match session id will be auto populated by calling ovr_User_GetPresenceMatchSessionId() from the inviters' viewer context.

ovrUserPresenceStatus ovr_User_GetPresenceStatus

( const ovrUserHandle obj )

An enum value for the different statuses representing what the user is currently doing. The different statuses can be ovrUserPresenceStatus_Unknown, ovrUserPresenceStatus_Offline, ovrUserPresenceStatus_Online.

const char * ovr_User_GetSmallImageUrl

( const ovrUserHandle obj )

The url of the smaller/secondary profile picture that is chosen by the user. Retrieve this url by using ovr_User_GetSmallImageUrl().