API reference

User Class

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, com.meta.horizon.platform.ovr.models.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.

Constructors

User ( ptr )
Signature 
com.meta.horizon.platform.ovr.models.User.User(final long ptr)
Parameters
ptr: final long

Methods

getDisplayName ()
A potentially non unique displayable name chosen by the user. Could also be the same as the oculus_ID. This is often the name shown to other users.
Signature 
String com.meta.horizon.platform.ovr.models.User.getDisplayName()
Returns
String  String
getID ()
The ID of the user, com.meta.horizon.platform.ovr.models.User#getID(). This is a unique value for every individual user.
Signature 
long com.meta.horizon.platform.ovr.models.User.getID()
Returns
long  long
getImageURL ()
The url of the profile picture that is chosen by the user. Retrieve this url by using com.meta.horizon.platform.ovr.requests.Users#getLoggedInUser().
Signature 
String com.meta.horizon.platform.ovr.models.User.getImageURL()
Returns
String  String
getManagedInfo ()
Managed account info, com.meta.horizon.platform.ovr.models.ManagedInfo, 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.
Signature 
ManagedInfo com.meta.horizon.platform.ovr.models.User.getManagedInfo()
Returns
ManagedInfo ManagedInfo
getOculusID ()
The oculus ID of the user. This is used across the developer dashboard and is unique to oculus.
Signature 
String com.meta.horizon.platform.ovr.models.User.getOculusID()
Returns
String  String
getPresence ()
Human readable string of what the user is currently doing. Not intended to be parsed as it might change at anytime or be translated.
Signature 
String com.meta.horizon.platform.ovr.models.User.getPresence()
Returns
String  String
getPresenceDeeplinkMessage ()
Intended to be parsed and used to deeplink to parts of the app. Read more about deeplinking here.
Signature 
String com.meta.horizon.platform.ovr.models.User.getPresenceDeeplinkMessage()
Returns
String  String
getPresenceDestinationApiName ()
If provided, this is the unique API Name that refers to the com.meta.horizon.platform.ovr.models.Destination this user is currently at in the app. Read more about destinations here
Signature 
String com.meta.horizon.platform.ovr.models.User.getPresenceDestinationApiName()
Returns
String  String
getPresenceLobbySessionId ()
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 com.meta.horizon.platform.ovr.models.User#getPresenceLobbySessionId() from the inviters' viewer context.
Signature 
String com.meta.horizon.platform.ovr.models.User.getPresenceLobbySessionId()
Returns
String  String
getPresenceMatchSessionId ()
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 com.meta.horizon.platform.ovr.models.User#getPresenceMatchSessionId() from the inviters' viewer context.
Signature 
String com.meta.horizon.platform.ovr.models.User.getPresenceMatchSessionId()
Returns
String  String
getPresenceStatus ()
An enum value for the different statuses representing what the user is currently doing. The different statuses can be com.meta.horizon.platform.ovr.enums.UserPresenceStatus#Unknown, com.meta.horizon.platform.ovr.enums.UserPresenceStatus#Offline, com.meta.horizon.platform.ovr.enums.UserPresenceStatus#Online.
Signature 
UserPresenceStatus com.meta.horizon.platform.ovr.models.User.getPresenceStatus()
Returns
UserPresenceStatus  UserPresenceStatus
getSmallImageUrl ()
The url of the smaller/secondary profile picture that is chosen by the user. Retrieve this url by using com.meta.horizon.platform.ovr.models.User#getSmallImageUrl().
Signature 
String com.meta.horizon.platform.ovr.models.User.getSmallImageUrl()
Returns
String  String
Meta
English (US)
© 2026 Meta