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.

Member Functions

User

( final long ptr )

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

Returns

String

long getID ( )

The ID of the user, com.meta.horizon.platform.ovr.models.User#getID(). This is a unique value for every individual user.

Returns

long

String 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().

Returns

String

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

Returns

ManagedInfo

String getOculusID ( )

The oculus ID of the user. This is used across the developer dashboard and is unique to oculus.

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.

Returns

String

String getPresenceDeeplinkMessage ( )

Intended to be parsed and used to deeplink to parts of the app. Read more about deeplinking here.

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

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.

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.

Returns

String

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

Returns

UserPresenceStatus

String 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().

Returns

String