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

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, 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.

Constructors

User ( o )
Signature
Oculus.Platform.Models.User.User(IntPtr o)
Parameters
o: IntPtr

Fields

DisplayName : readonly 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.
Signature
readonly string Oculus.Platform.Models.User.DisplayName
ID : readonly UInt64
The ID of the user, User::ID. This is a unique value for every individual user.
Signature
readonly UInt64 Oculus.Platform.Models.User.ID
ImageURL : readonly string
The url of the profile picture that is chosen by the user. Retrieve this url by using Users.GetLoggedInUser().
Signature
readonly string Oculus.Platform.Models.User.ImageURL
ManagedInfo : readonly ManagedInfo
Signature
readonly ManagedInfo Oculus.Platform.Models.User.ManagedInfo
ManagedInfoOptional : readonly ManagedInfo
Managed account info, 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
readonly ManagedInfo Oculus.Platform.Models.User.ManagedInfoOptional
OculusID : readonly string
The oculus ID of the user. This is used across the developer dashboard and is unique to oculus.
Signature
readonly string Oculus.Platform.Models.User.OculusID
Presence : readonly 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.
Signature
readonly string Oculus.Platform.Models.User.Presence
PresenceDeeplinkMessage : readonly string
Intended to be parsed and used to deeplink to parts of the app. Read more about deeplinking here.
Signature
readonly string Oculus.Platform.Models.User.PresenceDeeplinkMessage
PresenceDestinationApiName : readonly string
If provided, this is the unique API Name that refers to the Models.Destination this user is currently at in the app. Read more about destinations here
Signature
readonly string Oculus.Platform.Models.User.PresenceDestinationApiName
PresenceLobbySessionId : readonly 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 User::PresenceLobbySessionId from the inviters' viewer context.
Signature
readonly string Oculus.Platform.Models.User.PresenceLobbySessionId
PresenceMatchSessionId : readonly 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 User::PresenceMatchSessionId from the inviters' viewer context.
Signature
readonly string Oculus.Platform.Models.User.PresenceMatchSessionId
PresenceStatus : readonly UserPresenceStatus
An enum value for the different statuses representing what the user is currently doing. The different statuses can be UserPresenceStatus.Unknown, UserPresenceStatus.Offline, UserPresenceStatus.Online.
Signature
readonly UserPresenceStatus Oculus.Platform.Models.User.PresenceStatus
SmallImageUrl : readonly string
The url of the smaller/secondary profile picture that is chosen by the user. Retrieve this url by using User::SmallImageUrl.
Signature
readonly string Oculus.Platform.Models.User.SmallImageUrl