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

Users Class

This class provides methods to access information about the Models.User. It allows you to retrieve a user's ID, access token, and org-scoped ID, as well as their friends list and recently met users. Additionally, it provides methods to launch various flows such as blocking, unblocking, reporting, and sending friend requests. It's useful when you need to manage user relationships or perform actions that require user authentication within your application.

Static Member Functions

static string GetLoggedInUserLocale ( )
Retrieve the user with the given ID. This might fail if the ID is invalid or the user is blocked.NOTE: Users will have a unique ID per application.
Parameters
userID
User ID retrieved with this application.
Return an access token string for this user, suitable for making REST calls against graph.oculus.com.
Return the IDs of users entitled to use the current app that are blocked by the specified user
Returns a list of linked accounts that are associated with the specified service providers.Customization can be done via UserOptions. Create this object with UserOptions(). The params that could be used are:Example custom C++ usage:auto options = ovr_UserOptions_Create(); ovr_UserOptions_AddServiceProvider(options, ovrServiceProvider_Google); ovr_UserOptions_AddServiceProvider(options, ovrServiceProvider_Dropbox); ovr_User_GetLinkedAccounts(options); ovr_UserOptions_Destroy(options);
Parameters
userOptions
Additional configuration for this request It is optional and the options can be created by UserOptions()
  1. UserOptions.AddServiceProvider() - returns the list of linked accounts that are associated with these specified service providers.
Retrieve the currently signed in user. This call is available offline.NOTE: This will not return the user's presence as it should always be 'online' in your application.NOTE: Users will have a unique ID per application.Error codes
  • 100: Something went wrong.
Retrieve a list of the logged in user's bidirectional followers. The payload type will be an array of Models.User
Retrieve the currently signed in user's managed info. This call is not available offline.NOTE: This will return data only if the logged in user is a managed Meta account (MMA).
returns an ovrID which is unique per org. allows different apps within the same org to identify the user.
Parameters
userID
The id of the user that we are going to get its org scoped ID Models.OrgScopedID.
Returns all accounts belonging to this user. Accounts are the Oculus user and x-users that are linked to this user.
Part of the scheme to confirm the identity of a particular user in your backend. You can pass the result of Users.GetUserProof() and a user ID from User::ID to your backend. Your server can then use our api to verify identity. 'https://graph.oculus.com/user_nonce_validate?nonce=USER_PROOF&us er_id=USER_ID&access_token=ACCESS_TOKEN'NOTE: The nonce is only good for one check and then it is invalidated.
Launch the flow for blocking the given user. You can't follow, be followed, invited, or searched by a blocked user, for example. You can remove the block via ovr_User_LaunchUnblockFlow.
Parameters
userID
The ID of the user that the viewer is going to launch the block flow request.
Launch the flow for sending a follow request to a user.
Parameters
userID
The ID of the target user that is going to send the friend follow request to.
Launch the flow for unblocking a user that the viewer has blocked.
Parameters
userID
The ID of the user that the viewer is going to launch the unblock flow request.
static Request< Models.BlockedUserList > GetNextBlockedUserListPage
static Request< Models.UserList > GetNextUserListPage
( Models.UserList list )
static Request< Models.UserCapabilityList > GetNextUserCapabilityListPage
Did you find this page helpful?
Thumbs up icon
Thumbs down icon