OVRPlatformCppRequests.h File

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

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.

Retrieve all achievement definitions for the app, including their name, unlock requirements, and any additional details.

Retrieve the progress for the user on all achievements in the app.

Retrieve the achievement definitions that match the specified names, including their name, unlock requirements, and any additional details.

Retrieve the user's progress on the achievements that match the specified names.

Unlock the achievement with the given name. This can be of any achievement type: a simple unlock, count-based, or bitfield-based achievement. The Meta Quest Platform supports three types of achievements: simple, count and bitfield. Each achievement type has a different unlock mechanism. Simple achievements are all-or-nothing. They are unlocked by a single event or objective completion. For example, a simple achievement is unlocked when Frodo reaches Mount Doom. Count achievements are unlocked when a counter reaches a defined target. Define the field FOvrAchievementDefinition::Target to reach that triggers the achievement. For example, a target achievement is unlocked when Darth Vader chokes 3 disappointing Imperial officers. Bitfield achievements are unlocked when a target number of bits in a bitfield are set. Define the field FOvrAchievementDefinition::Target and field FOvrAchievementDefinition::BitfieldLength that triggers the achievement. For example, a bitfield achievement is unlocked when Harry destroys 5 of the 7 Horcruxes.

Cancel an app download that is in progress. It will return a result when the download is cancelled.

Track download progress for an app.

Requests version information, including the field FOvrApplicationVersion::CurrentCode and field FOvrApplicationVersion::CurrentName of the currently installed app and field FOvrApplicationVersion::LatestCode, field FOvrApplicationVersion::LatestName, field FOvrApplicationVersion::Size and field FOvrApplicationVersion::ReleaseDate of the latest app update.

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

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

Starts an app download. It will return a result when the download is finished. Download progress can be monitored using the UOvrRequestsBlueprintLibrary::Application_CheckAppDownloadProgress().

Deprecated

Removes a 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 a 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

Downloads an asset file by its ID on demand. Returns an object containing the asset ID and filepath. Sends periodic UOvrPlatformSubsystem::OnAssetFileDownloadUpdate() 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.

Deprecated

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 asset details with asset file names and their associated IDs field FOvrAssetDetails::AssetId, and whether it's currently installed field FOvrAssetDetails::DownloadStatus.

Deprecated

Returns the details FOvrAssetDetails on a single asset: ID, file name, and whether it's currently installed

Returns the details FOvrAssetDetails on a single asset: ID, file name, and whether it's currently installed

Launches the Avatar Editor. Meta Avatars Editor is a feature that allows users to edit their Meta Avatars appearances within the VR application that they are currently using. This experience is often used by users to switch their outfit and accessories to better suit the VR experience they are experiencing. The result can be retrieved by field FOvrAvatarEditorResult::RequestSent.

Deprecated

If the current user has the necessary permissions, they can decline a challenge by providing the challenge ID, which can be obtained using field FOvrChallenge::ID.

Deprecated

Gets detailed information for a single challenge by providing the challenge ID, which can be retrieved by calling field FOvrChallenge::ID.

Retrieves a list of entries for a specific challenge, with options to filter and limit the results. By providing the challengeID, you can specify which challenge's entries you want to retrieve. The limit parameter allows you to control the number of entries returned. The filter parameter enables you to refine the results to only include entries from users who are bidirectional followers. The startAt parameter allows you to define whether to center the query on the user or start at the top of the challenge.

Returns a list of entries for a specific challenge, starting from a specified rank. By providing the challengeID and rank, you can specify which challenge's entries you want to retrieve and where to start the query. The limit parameter allows you to control the number of entries returned.

Retrieves a list of challenge entries for a specific set of user IDs, with options to filter and limit the results. This method is useful for retrieving a list of challenge entries for a specific set of users, allowing you to display their progress and rankings within the challenge.

Returns a list of challenges that match the specified options. The FOvrChallengeOptions parameter allows you to specify the criteria for the challenges you want to retrieve. The limit parameter allows you to control the number of challenges returned.

If the current user has the necessary permissions to join, participate in a challenge by providing the challenge ID, which can be retrieved using field FOvrChallenge::ID.

If the current user has the necessary permissions, they can leave a challenge by providing the challenge ID, which can be obtained using field FOvrChallenge::ID.

Deprecated

Retrieve the presenter data that drives an active cowatching session. This method can be called when there is an ongoing cowatching session, allowing developers to access and utilize the presenter data to enhance the user experience.

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

Check whether the current user is participating in the ongoing cowatching session. It returns a boolean value field FOvrCowatchingState::InSession indicating the user's presence in the session.

Join the ongoing cowatching session as a viewer, updating data only possible for users already in the session.

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

Leave the current cowatching session, rendering viewer data obsolete and no longer relevant to the ongoing experience.

Request to initiate a cowatching session as the presenter while being copresent in a shared virtual home environment.

Stop being the presenter and terminate the ongoing cowatching session. This action will effectively end the shared media experience.

Set the data that drives a cowatching session. This method is only callable by the presenter. The video title cannot exceed 100 characters, and the 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. The data size is limited to 500 characters, and it will eventually become consistent across all users.

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). See more details here.

Returns whether the current user is entitled to the current app. The primary purpose of this function is to verify user access rights to the application, ensuring that the user is authorized to use it. See example usage here.

Clears the current group presence settings for your app. Use this when a user's group presence setting in your app needs to be changed when moving to new destinations in your app.

Returns a list of users that can be invited to your current lobby. These are pulled from your bidirectional followers and recently met lists.

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

Launches the system invite dialog with a roster of eligible users for the current user to invite to the app. It is recommended that you surface a button in your UI that triggers this dialog when a user is joinable.

Launch an error dialog window with predefined messages for commonly occurring multiplayer errors. Check the Invokable Error Dialogs documentation for more information about these error messages and their values.

Launch the dialog allowing users to rejoin a previous lobby or match. Either the user's FOvrGroupPresenceOptions::LobbySessionId, their FOvrGroupPresenceOptions::MatchSessionId, or both must be populated as valid rejoinable destinations. Check the Rejoin documentation for use cases and information on this feature.

Launch the panel displaying the current users in the roster. We do not recommend using this API because the list current users is surfaced in the Destination UI when the Meta Quest button is pressed.

Sends invites to the current application to the list of userIDs passed in. You can fetch a list of users to pass in via the UOvrRequestsBlueprintLibrary::GroupPresence_GetInvitableUsers(). This API works as an alternative to UOvrRequestsBlueprintLibrary::GroupPresence_LaunchInvitePanel() which delegates the invite flow to the system invite module. UOvrRequestsBlueprintLibrary::GroupPresence_LaunchInvitePanel() is the recommended approach.

Sets group presence information for your current app. It is recommended that you use this parameter and its methods to set group presence information for your app. An example of using this parameter can be found on the Group Presence overview page where the methods to set FOvrGroupPresenceOptions::DestinationApiName, FOvrGroupPresenceOptions::MatchSessionId, and FOvrGroupPresenceOptions::LobbySessionId are used.

Sets the user's FOvrGroupPresenceOptions::DeeplinkMessageOverride 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. This method does not power travel from the Meta Quest platform to your app. You must set a user's FOvrGroupPresenceOptions::DestinationApiName, FOvrGroupPresenceOptions::IsJoinable status, and FOvrGroupPresenceOptions::LobbySessionId to enable travel to your app. Check Group Presence overview for more information about these values. Note: Instead of using this standalone API, we recommend setting all GroupPresence parameters in one call to UOvrRequestsBlueprintLibrary::GroupPresence_Set().

Replaces the user's current FOvrGroupPresenceOptions::DestinationApiName with the provided one. Use this to set a user's current destination while keeping all the other Group Presence parameters the same. Setting a user's destination is required to enable travel from the Meta Quest Platform to your app. NOTE instead of using the standalone API, we recommend setting all GroupPresence parameters in one call to UOvrRequestsBlueprintLibrary::GroupPresence_Set(). This helps ensure that all relevant presence information is singularly updated and helps reduce presence errors.

Sets a user's current presence as joinable. Use this method to update a user's joinability as it changes. For example, when the game starts, the lobby becomes full, the user moves to a private, non joinable instance while keeping all other GroupPresence parameters (i.e FOvrGroupPresenceOptions::DestinationApiName, FOvrGroupPresenceOptions::LobbySessionId, FOvrGroupPresenceOptions::MatchSessionId) the same. Setting a user's destination is required to enable travel from the Meta Quest Platform to your app. Note: Instead of using this individual API, we recommend setting all GroupPresence information with the UOvrRequestsBlueprintLibrary::GroupPresence_Set() method and its associated parameters to simply managing all presence information. This helps ensure that all relevant presence information is singularly updated and helps reduce presence errors.

Replaces the user's current FOvrGroupPresenceOptions::LobbySessionId for the provided string. Use this to set a user's current lobby session id while keeping all other GroupPresence parameters the same. Setting a user's lobby session id is required to enable travel from the Meta Quest Platform to your app. Check Group presence overview for more information. NOTE instead of using the standalone API, we recommend setting all GroupPresence parameters in one call to UOvrRequestsBlueprintLibrary::GroupPresence_Set(). This helps ensure that all relevant presence information is singularly updated and helps reduce presence errors.

Replaces the user's current FOvrGroupPresenceOptions::MatchSessionId for the provided one. Use this to update the user's current match session id while keeping all other GroupPresence parameters the same. FOvrGroupPresenceOptions::MatchSessionId works in conjuction with FOvrGroupPresenceOptions::LobbySessionId to determine if users are playing together. If a user's match and lobby session ids are the same, they should be in the same multiplayer instance together. Users with the same lobby session id but different match session ids may be in the same lobby for things like voice chat while in different instances in your app. WARNING match session id is often treated the same as lobby session id, but this is in fact a distinct parameter and is not used for travel from the Meta Quest Platform. NOTE instead of using the standalone API, we recommend setting all GroupPresence parameters in one call to UOvrRequestsBlueprintLibrary::GroupPresence_Set().

Allow the consumable IAP product to be purchased again. Conceptually, this indicates that the item was used or consumed. Important: Make sure to pass the correct SKU of the purchase that will be consumed. This value is case-sensitive and should match exactly with the product SKU set in the Developer Dashboard.

Retrieve a list of IAP products that can be purchased. Note: You must provide a list of SKUs (Stock Keeping Units) to retrieve the corresponding product information. The SKUs are used to identify the products in the Oculus store, which can be retrieved by accessing the Developer Dashboard or by field FOvrPurchase::SKU.

Retrieve a list of Purchase that the Logged-In-User has made. This list will also contain consumable purchases that have not been consumed. Note: This method returns all purchases, including consumable and non-consumable ones. If you only want to retrieve durable purchases, use get_viewer_purchases_durable_cache instead.

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. Important: It is recommended to use UOvrRequestsBlueprintLibrary::IAP_GetViewerPurchases() first and only check the cache if that fails. This method is intended as a fallback mechanism and may not always return up-to-date results.

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 resolve it, if possible. Returns a purchase on success, and an error on user cancellation or other errors.In the case of a user cancelation, the field FOvrError::Message value will contain a JSON object with a "category" property containing a value of "user_canceled".

Returns currently installed and selected language pack for an app in the view of the FOvrAssetDetails. Use field FOvrAssetDetails::Language field to extract needed language info. A particular language can be download and installed by a user from the Oculus app on the application page.

Sets the current language to specified. The parameter is the BCP47 language tag. If a language pack is not downloaded yet, spawns automatically the UOvrRequestsBlueprintLibrary::AssetFile_DownloadByName() request, and sends periodic UOvrPlatformSubsystem::OnAssetFileDownloadUpdate() to track the downloads. Once the language asset file is downloaded, call UOvrRequestsBlueprintLibrary::LanguagePack_GetCurrent() to retrieve the data, and use the language at runtime.

Retrieves detailed information for a single leaderboard with a specified name, returning an array of FOvrLeaderboard.

Retrieves a list of leaderboard entries for a specified LeaderboardName, with options to filter and limit the number of results returned.

Retrieves a block of leaderboard entries starting from a specific rank.

Retrieves a block of leaderboard entries that match the specified user IDs. Only entries corresponding to the provided user IDs will be returned.

Writes a single entry to the leaderboard, returning FOvrLeaderboardUpdateStatus indicating whether the update was successful and providing the updated challenge IDs.

Writes a single entry to a leaderboard which can include supplementary metrics, returning FOvrLeaderboardUpdateStatus indicating whether the update was successful and providing the updated challenge IDs.

Launch the Share to Facebook modal, 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). The payload for the result is defined as FOvrShareMediaResult.

Marks a notification as read, causing it to disappear from various surfaces such as the Universal Menu and in-app retrieval. This action is useful for indicating that the user has acknowledged or acted upon the notification.

Load the current party the current FOvrUser is in. The returned FOvrParty will then contain information about other users in the party and invited users. If the user is not currently in a party, the request will return an error message with code 10.

Register the device to receive push notification. The registered notification id can be fetched by field FOvrPushNotificationResult::Id.

Deprecated

Gets all the FOvrDestination that the presence can be set to

Deprecated

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.

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 withFOvrUserOptions. The params that could be used are:Example custom C++ usage:<codeblock> 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); </codeblock>

1. FOvrUserOptions::ServiceProviders.Emplace() - 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.

Retrieve a list of the logged in user's bidirectional followers. The payload type will be an array of FOvrUser

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.

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 UOvrRequestsBlueprintLibrary::User_GetUserProof() and a user ID from field FOvrUser::ID to 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. It can be used in field FOvrUserAccountAgeCategory::AgeCategory

Report the current user's age category to Meta.

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. Returns a microphone availability state flag which determines whether it is available or not - FOvrMicrophoneAvailabilityState.

Sets whether SystemVoip should be suppressed so that this app's Voip can use the microphone and play incoming Voip audio. Once microphone switching functionality for the user is released, this function will no longer work. You can use UOvrRequestsBlueprintLibrary::Voip_GetMicrophoneAvailability() to see if the user has allowed the app access to the microphone. This returns a FOvrSystemVoipState object which contains statuses about whether the microphone is muted or whether passthrough is enabled.