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

Users Class

Static Methods

Get ( userID )
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.
Signature
static Request<Models.User> Oculus.Platform.Users.Get(UInt64 userID)
Parameters
userID: UInt64  User ID retrieved with this application.
GetAccessToken ()
Return an access token for this user, suitable for making REST calls against graph.oculus.com.
Signature
static Request<string> Oculus.Platform.Users.GetAccessToken()
Returns
Request< string >
GetBlockedUsers ()
Return the IDs of users entitled to use the current app that are blocked by the specified user
Signature
static Request<Models.BlockedUserList> Oculus.Platform.Users.GetBlockedUsers()
GetLoggedInUser ()
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.
Signature
static Request<Models.User> Oculus.Platform.Users.GetLoggedInUser()
GetLoggedInUserFriends ()
Retrieve a list of the logged in user's bidirectional followers.
Signature
static Request<Models.UserList> Oculus.Platform.Users.GetLoggedInUserFriends()
GetLoggedInUserLocale ()
Signature
static string Oculus.Platform.Users.GetLoggedInUserLocale()
Returns
string
GetNextBlockedUserListPage ( list )
Signature
static Request<Models.BlockedUserList> Oculus.Platform.Users.GetNextBlockedUserListPage(Models.BlockedUserList list)
Parameters
GetNextUserCapabilityListPage ( list )
Signature
static Request<Models.UserCapabilityList> Oculus.Platform.Users.GetNextUserCapabilityListPage(Models.UserCapabilityList list)
GetNextUserListPage ( list )
Signature
static Request<Models.UserList> Oculus.Platform.Users.GetNextUserListPage(Models.UserList list)
Parameters
GetOrgScopedID ( userID )
returns an ovrID which is unique per org. allows different apps within the same org to identify the user.
Signature
static Request<Models.OrgScopedID> Oculus.Platform.Users.GetOrgScopedID(UInt64 userID)
Parameters
userID: UInt64  to load the org scoped id of
GetSdkAccounts ()
Returns all accounts belonging to this user. Accounts are the Oculus user and x-users that are linked to this user.
Signature
static Request<Models.SdkAccountList> Oculus.Platform.Users.GetSdkAccounts()
GetUserProof ()
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 Users.Get() to your your backend. Your server can then use our api to verify identity. 'https://graph.oculus.com/user_nonce_validate?nonce=USER_P ROOF&user_id=USER_ID&access_token=ACCESS_TOKEN'
NOTE: The nonce is only good for one check and then it is invalidated.
Signature
static Request<Models.UserProof> Oculus.Platform.Users.GetUserProof()
LaunchBlockFlow ( userID )
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.
Signature
static Request<Models.LaunchBlockFlowResult> Oculus.Platform.Users.LaunchBlockFlow(UInt64 userID)
Parameters
userID: UInt64  User ID of user being blocked
LaunchFriendRequestFlow ( userID )
Launch the flow for sending a follow request to a user.
Signature
static Request<Models.LaunchFriendRequestFlowResult> Oculus.Platform.Users.LaunchFriendRequestFlow(UInt64 userID)
Parameters
userID: UInt64  User ID of user to send a follow request to
LaunchUnblockFlow ( userID )
Launch the flow for unblocking a user that the viewer has blocked.
Signature
static Request<Models.LaunchUnblockFlowResult> Oculus.Platform.Users.LaunchUnblockFlow(UInt64 userID)
Parameters
userID: UInt64  User ID of user to unblock