interface User
displayName
: String?
[Get] |
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
abstract val displayName: String? |
id
: String
[Get] |
The ID of the user, User.id. This is a unique value for every individual user.
Signature
abstract val id: String |
imageUrl
: String?
[Get] |
The url of the profile picture that is chosen by the user. Retrieve this url by using horizon.platform.users.Users.getLoggedInUser.
Signature
abstract val imageUrl: String? |
managedInfo
: ManagedInfo?
[Get] |
Managed account info, 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
abstract val managedInfo: ManagedInfo? |
oculusId
: String?
[Get] |
The oculus ID of the user. This is used across the developer dashboard and is unique to oculus.
Signature
abstract val oculusId: String? |
presence
: String?
[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.
Signature
abstract val presence: String? |
presenceDeeplinkMessage
: String?
[Get] |
Intended to be parsed and used to deeplink to parts of the app. Read more about deeplinking here.
Signature
abstract val presenceDeeplinkMessage: String? |
presenceDestinationApiName
: String?
[Get] |
If provided, this is the unique API Name that refers to the Destination this user is currently at in the app. Read more about destinations here
Signature
abstract val presenceDestinationApiName: String? |
presenceLobbySessionId
: String?
[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 User.presenceLobbySessionId from the inviters' viewer context.
Signature
abstract val presenceLobbySessionId: String? |
presenceMatchSessionId
: String?
[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 User.presenceMatchSessionId from the inviters' viewer context.
Signature
abstract val presenceMatchSessionId: String? |
presenceStatus
: UserPresenceStatus?
[Get] |
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
abstract val presenceStatus: UserPresenceStatus? |
smallImageUrl
: String?
[Get] |
The url of the smaller/secondary profile picture that is chosen by the user. Retrieve this url by using User.smallImageUrl.
Signature
abstract val smallImageUrl: String? |