API reference
FOvrUser Struct
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, field FOvrUser::ID. 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.
Fields
FString DisplayName[Get]
A potentially non unique displayable name chosen by the FOvrUser. Could also be the same as the oculus_ID. This is often the name shown to other users.
FOvrId ID[Get]
The ID of the user, field FOvrUser::ID. This is a unique value for every individual FOvrUser.
FString ImageUrl[Get]
The url of the profile picture that is chosen by the user. Retrieve this url by using field FOvrUser::ImageUrl.
FOvrManagedInfo ManagedInfo[Get]
Managed account info, FOvrManagedInfo, 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.
FString OculusID[Get]
The oculus ID of the FOvrUser. This is used across the developer dashboard and is unique to oculus.
FString Presence[Get]
Human readable string of what the user is currently doing. Not intended to be parsed as it might change at anytime or be translated.
FString PresenceDeeplinkMessage[Get]
Intended to be parsed and used to deeplink to parts of the app. Read more about deeplinking here.
FString PresenceDestinationApiName[Get]
If provided, this is the unique API Name that refers to the FOvrDestination this user is currently at in the app. Read more about destinations here
FString PresenceLobbySessionId[Get]
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 field FOvrUser::PresenceLobbySessionId from the inviters' viewer context.
FString PresenceMatchSessionId[Get]
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 field FOvrUser::PresenceMatchSessionId from the inviters' viewer context.
EOvrUserPresenceStatus PresenceStatus[Get]
An enum value for the different statuses representing what the user is currently doing. The different statuses can be EOvrUserPresenceStatus::Unknown, EOvrUserPresenceStatus::Offline, EOvrUserPresenceStatus::Online.
FString SmallImageUrl[Get]
The url of the smaller/secondary profile picture that is chosen by the user. Retrieve this url by using field FOvrUser::SmallImageUrl.
Member Functions
FOvrUser ( )
This is the default constructor for the struct, which initializes the ovrUserHandle and TOvrMessageHandlePtr to their default values.
FOvrUser
( ovrUserHandle OvrHandle,
TOvrMessageHandlePtr MessageHandlePtr )
Copying values from an OVR handle to the array, and the originating message to prevent the handle from being freed.
void Clear ( )
Setting all values to their defaults, effectively clearing the struct.
void Update
( ovrUserHandle OvrHandle,
TOvrMessageHandlePtr MessageHandlePtr )
Updating values from an OVR handle to the array, and the originating message to prevent the handle from being freed.
Did you find this page helpful?
Virtual reality / Meta Horizon
Support and legal
Virtual reality / Meta Horizon
Support and legal
Virtual reality / Meta Horizon
Support and legal
English (US)
© 2025 Meta