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

User

Updated: Aug 26, 2025

User

interface User
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, horizon.platform.users.models.User.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.

Properties

NameSummary
displayName
abstract val displayName: String?
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.
id
abstract val id: String
The ID of the user, horizon.platform.users.models.User.id. This is a unique value for every individual user.
imageUrl
abstract val imageUrl: String?
The url of the profile picture that is chosen by the user. Retrieve this url by using horizon.platform.users.Users.getLoggedInUser.
json
open val json: String
managedInfo
abstract val managedInfo: ManagedInfo?
Managed account info, horizon.platform.users.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.
oculusId
abstract val oculusId: String?
The oculus ID of the user. This is used across the developer dashboard and is unique to oculus.
presence
abstract val presence: String?
Human readable string of what the user is currently doing. Not intended to be parsed as it might change at anytime or be translated.
presenceDeeplinkMessage
abstract val presenceDeeplinkMessage: String?
Intended to be parsed and used to deeplink to parts of the app. Read more about deeplinking here.
presenceDestinationApiName
abstract val presenceDestinationApiName: String?
If provided, this is the unique API Name that refers to the horizon.platform.richpresence.models.Destination this user is currently at in the app. Read more about destinations here
presenceLobbySessionId
abstract val presenceLobbySessionId: String?
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 horizon.platform.users.models.User.presenceLobbySessionId from the inviters’ viewer context.
presenceMatchSessionId
abstract val presenceMatchSessionId: String?
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 horizon.platform.users.models.User.presenceMatchSessionId from the inviters’ viewer context.
presenceStatus
abstract val presenceStatus: UserPresenceStatus?
An enum value for the different statuses representing what the user is currently doing. The different statuses can be horizon.platform.users.enums.UserPresenceStatus.unknown, horizon.platform.users.enums.UserPresenceStatus.offline, horizon.platform.users.enums.UserPresenceStatus.online.
smallImageUrl
abstract val smallImageUrl: String?
The url of the smaller/secondary profile picture that is chosen by the user. Retrieve this url by using horizon.platform.users.models.User.smallImageUrl.
Did you find this page helpful?
Thumbs up icon
Thumbs down icon