OVRPlatformCppRequests.h File

Add 'count' to the achievement with the given name. This must be a COUNT achievement. The largest number that is supported by this method is the max value of a signed 64-bit integer. If the number is larger than that, it is clamped to that max value before being passed to the servers.Unlock fields of a BITFIELD achievement. Unlock the achievement with the given name. This can be of any achievement type.

Request all achievement definitions for the app.Request the achievement definitions that match the specified names.

Request the progress for the user on all achievements in the app.Request the user's progress on the specified achievements.

Cancel an app download that is in progress. It will return a result when the download is cancelled.Installs the app update that was previously downloaded. Once the install begins the application will exit automatically. After the installation process is complete, the app will be relaunched based on the options passed. Starts an app download. It will return a result when the download is finished. Download progress can be monitored using the check_app_download_progress API.

Track download progress for an app

Requests version information, including the version code and version name of the currently installed app and version code, version name, size and release date of the latest app update

Launches a different application in the user's library. If the user does not have that application installed, they will be taken to that app's page in the Oculus Store Presenter data is used to drive a cowatching session. This can be called when there is an active cowatching session.Returns Device and Application Integrity Attestation JSON Web Token. The token has format of header.claims.signature encoded in base64. Header contains algorithm type (PS256) and token type (JWT).Return an access token for this user, suitable for making REST calls against graph.oculus.com.

DEPRECATED. Use AssetFile_DeleteById()Removes an previously installed asset file from the device by its ID. Returns an object containing the asset ID and file name, and a success flag. Removes an previously installed asset file from the device by its name. Returns an object containing the asset ID and file name, and a success flag.

DEPRECATED. Use AssetFile_DownloadById()Downloads an asset file by its ID on demand. Returns an object containing the asset ID and filepath. Sends periodic FOvrNotification_AssetFile_DownloadUpdate to track the downloads. Downloads an asset file by its name on demand. Returns an object containing the asset ID and filepath. Sends periodic {notifications.asset_file.download_update}} to track the downloads. Sets the current language to specified. The parameter is the BCP47 language tag. If a language pack is not downloaded yet, spawns automatically the AssetFile_DownloadByName() request, and sends periodic FOvrNotification_AssetFile_DownloadUpdate to track the downloads. Once the language asset file is downloaded, call LanguagePack_GetCurrent() to retrive the data, and use the language at runtime.

DEPRECATED. Use AssetFile_DownloadCancelById()Cancels a previously spawned download request for an asset file by its ID. Returns an object containing the asset ID and file path, and a success flag. Cancels a previously spawned download request for an asset file by its name. Returns an object containing the asset ID and file path, and a success flag.

Returns an array of objects with asset file names and their associated IDs, and and whether it's currently installed.

DEPRECATED. Use AssetFile_StatusById()Returns the details on a single asset: ID, file name, and whether it's currently installed Returns the details on a single asset: ID, file name, and whether it's currently installed Returns currently installed and selected language pack for an app in the view of the asset_details. Use language field to extract neeeded language info. A particular language can be download and installed by a user from the Oculus app on the application page.

Launches the Avatar Editor

DEPRECATED. Use server-to-server API call instead.If the current user has an invite to the challenge, decline the inviteGets the information for a single challenge If the current user has permission, join the challengeIf the current user has permission, leave the challenge

Requests a block of challenge entries. Requests a block of challenge entries. Requests a block of challenge entries. Will return only entries matching the user IDs passed in.

Requests for a list of challenge

Get the viewer data of everyone who is in a cowatching session whose data was set by Cowatching_SetViewerData(). This can be called when there is an active cowatching session.

Check whether the current user is in the current cowatching session.

Returns a list of users that can be invited to your current lobby. These are pulled from your bidirectional followers and recently met lists.Retrieve a list of the logged in user's bidirectional followers.

Get the application invites which have been sent by the user.

Launch the flow to allow the user to invite others to their current session. This can only be used if the user is in a joinable session.

Launch the dialog which will allow the user to rejoin a previous lobby/match. Either the lobby_session_id or the match_session_id, or both, must be populated.

Send application invites to the passed in userIDs.

Retrieve a list of IAP products that can be purchased.

Retrieve a list of Purchase that the Logged-In-User has made. This list will also contain consumable purchases that have not been consumed.Retrieve a list of Purchase that the Logged-In-User has made. This list will only contain durable purchase (non-consumable) and is populated from a device cache. It is recommended in all cases to use ovr_User_GetViewerPurchases first and only check the cache if that fails.

Launch the checkout flow to purchase the existing product. Oculus Home tries handle and fix as many errors as possible. Home returns the appropriate error message and how to resolveit, if possible. Returns a purchase on success, empty purchase on cancel, and an error on error.

Gets the information for a single leaderboard

Requests a block of leaderboard entries. Requests a block of leaderboard entries. Requests a block of leaderboard entries. Will return only entries matching the user IDs passed in.

Writes a single entry to a leaderboard. Writes a single entry to a leaderboard, can include supplementary metrics

Launch the Share to Facebook modal via a deeplink to Home on Gear VR, allowing users to share local media files to Facebook. Accepts a postTextSuggestion string for the default text of the Facebook post. Requires a filePath string as the path to the image to be shared to Facebook. This image should be located in your app's internal storage directory. Requires a contentType indicating the type of media to be shared (only 'photo' is currently supported.)

Load the party the current user is in.

Gets all the destinations that the presence can be set to

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

Return the IDs of users entitled to use the current app that are blocked by the specified user

returns an ovrID which is unique per org. allows different apps within the same org to identify the user.

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 User_GetUserProof() and a user ID from User_Get() to your your backend. Your server can then use our api to verify identity. 'https://graph.oculus.com/user_nonce_validate?nonce=USER_PROOF&user_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.

Launch the flow for sending a follow request to a user.

Launch the flow for unblocking a user that the viewer has blocked.

Retrieve the user age category for the current user.

Gets whether the microphone is currently available to the app. This can be used to show if the user's voice is able to be heard by other users.

Sets whether SystemVoip should be suppressed so that this app's Voip can use the mic and play incoming Voip audio. Once microphone switching functionality for the user is released, this function will no longer work. You can use get_microphone_availability to see if the user has allowed the app access to the microphone.

The currently running application has indicated they want to show their in-app reporting flow or that they choose to ignore the request.

DEPRECATED. Use server-to-server API call instead.

Join the current cowatching session. Viewer data can only be updated by users who are in the session.

Launch a dialog for inviting users to cowatch in Copresent Home.

Leave the current cowatching session. Viewer data will no longer be relevant.

Request to start a cowatching session as the presenter while copresent in home.

Stop being the presenter. This will end the cowatching session.

Set the data that drives a cowatching session. This method is only callable by the presenter. Video title cannot exceed 100 characters, and data size is limited to 500 characters. The data will be eventually consistent across all users.

Set the current user's viewer data to be shared with copresent users. This can be called when there is an active cowatching session. Data size is limited to 500 characters. The data will be eventually consistent across all users.

Returns whether the current user is entitled to the current app.

Clear group presence for running app

Launch an error dialog with predefined messages for common multiplayer errors.

Launch the panel which displays the current users in the roster. Users with the same lobby and match session id as part of their presence will show up here.

Set group presence for running app

Set the user's deeplink message while keeping the other group presence parameters the same. If the destination of the user is not set, the deeplink message cannot be set as there's no deeplink message to override.

Replaces the user's current destination for the provided one. All other existing group presence parameters will remain the same.

Set if the current user's destination and session is joinable while keeping the other group presence parameters the same. If the destination or session ids of the user is not set, they cannot be set to joinable.

Replaces the user's current lobby session id for the provided one. All other existing group presence parameters will remain the same.

Replaces the user's current match session id for the provided one. All other existing group presence parameters will remain the same.

Allow the consumable IAP product to be purchased again. Conceptually, this indicates that the item was used or consumed.

Mark a notification as read. This causes it to disappear from the Universal Menu, the Oculus App, Oculus Home, and in-app retrieval.

DEPRECATED. Use the clear method in group presence

DEPRECATED. Use GroupPresence_Set().

Report the current user's age category to Meta.