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

UOvrRequestsBlueprintLibrary Class

Extends UBlueprintFunctionLibrary
The UOvrFunctionsBlueprintLibrary class provides a collection of static public member functions that can be used to interact with the Oculus platform. These functions include methods for handling abuse reports, achievements, asset files, challenges, cowatching, device application integrity, entitlements, group presence, in-app purchases, language packs, leaderboards, media sharing, notifications, parties, and user information. See more info about Platform Solution here.

Fields

Reference to an array of output pins that will be executed as a result of this request.
Information about the latent action that will be performed as a result of this request.
EOvrRequestOutputPins FLatentActionInfo FOvrId AssetFileID[Get]
Represents the payload of the request, if the request succeeded. These results can be used to provide more context and information about the outcome of the request.
Error message if the request failed, which contains failure reason, it is empty if the request succeeded.
Represents the payload of the request, if the request succeeded. These results can be used to provide more context and information about the outcome of the request.
Error message if the request failed, which contains failure reason, it is empty if the request succeeded.
Represents the payload of the request, if the request succeeded. These results can be used to provide more context and information about the outcome of the request.
Error message if the request failed, which contains failure reason, it is empty if the request succeeded.
Represents the payload of the request, if the request succeeded. These results can be used to provide more context and information about the outcome of the request.
Error message if the request failed, which contains failure reason, it is empty if the request succeeded.
EOvrRequestOutputPins FLatentActionInfo FOvrRichPresenceOptions RichPresenceOptions[Get]
Error message if the request failed, which contains failure reason, it is empty if the request succeeded.

Static Member Functions

The currently running application has indicated they want to show their in-app reporting flow or that they choose to ignore the request.
Parameters
Response
- Possible states that an app can respond to the platform notification that the in-app reporting flow has been requested by the user.
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.
Parameters
Name
- The api_name of the achievement that will be adding count, which can be retrieved by field FOvrAchievementDefinition::ApiName.
Count
- The value of count that will be added to the achievement.
Unlock fields of a BITFIELD achievement.
Parameters
Name
- The api_name of the Bitfield achievement whose field(s) will be unlocked, which can be retrieved by field FOvrAchievementDefinition::ApiName.
Fields
- A string containing either '0' or '1' characters. Every '1' will unlock the field in the corresponding position.
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.
Parameters
Names
- The api_names of the achievements used to retrieve the definition information, which can be retrieved by field FOvrAchievementDefinition::ApiName.
Count
- The number of specified achievements names.
Retrieve the user's progress on the achievements that match the specified names.
Parameters
Names
- The api_names of the achievements used to retrieve the progress information, which can be retrieved by field FOvrAchievementDefinition::ApiName.
Count
- The number of specified achievements 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.
Parameters
Name
- The api_name of the achievement that will be unlocked, which can be retrieved by field FOvrAchievementDefinition::ApiName.
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
Parameters
AppID
- The unique ID of the app to be launched.
Starts an app download. It will return a result when the download is finished. Download progress can be monitored using the Application_CheckAppDownloadProgress().
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.
Parameters
AssetFileID
- The asset file ID
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.
Parameters
AssetFileName
- The asset file name
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.
Parameters
AssetFileID
- The asset file ID
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.
Parameters
AssetFileName
- The asset file name
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.
Parameters
AssetFileID
- The asset file ID
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.
Parameters
AssetFileName
- The asset file name
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.
Returns the details FOvrAssetDetails on a single asset: ID, file name, and whether it's currently installed
Parameters
AssetFileID
- The asset file ID
Returns the details FOvrAssetDetails on a single asset: ID, file name, and whether it's currently installed
Parameters
AssetFileName
- The asset file name
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.
Parameters
Options
- A FOvrAvatarEditorOptions contains the options information, including an optional override for the source of the request, which is specified by FOvrAvatarEditorOptions::SourceOverride.
Deprecated
Use server-to-server API call instead.
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.
Parameters
ChallengeID
- The ID of challenge that the user is going to decline. It can be retrieved by field FOvrChallenge::ID.
Deprecated
Use server-to-server API call instead.
Gets detailed information for a single challenge by providing the challenge ID, which can be retrieved by calling field FOvrChallenge::ID.
Parameters
ChallengeID
- The id of the challenge whose entries to return, 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.
Parameters
ChallengeID
- The id of the challenge whose entries to return, which can be retrieved by calling field FOvrChallenge::ID.
Limit
- Sets a limit on the maximum number of challenges to be fetched, which can be useful for pagination or performance reasons.
Filter
- By using the EOvrLeaderboardFilterType, you can refine the results to only include entries from users who are bidirectional followers.
StartAt
- Defines whether to center the query on the user or start at the top of the challenge. If this is EOvrLeaderboardStartAt::CenteredOnViewer or EOvrLeaderboardStartAt::CenteredOnViewerOrTop, then the current user's ID will be automatically added to the query.
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.
Parameters
ChallengeID
- The id of the challenge whose entries to return, which can be retrieved by calling field FOvrChallenge::ID.
Limit
- Sets a limit on the maximum number of challenges to be fetched, which can be useful for pagination or performance reasons.
AfterRank
- The position after which to start. For example, 10 returns challenge results starting with the 11th user.
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.
Parameters
ChallengeID
- The id of the challenge whose entries to return, which can be retrieved by calling field FOvrChallenge::ID.
Limit
- Sets a limit on the maximum number of challenges to be fetched, which can be useful for pagination or performance reasons.
StartAt
- Defines whether to center the query on the user or start at the top of the challenge. If this is EOvrLeaderboardStartAt::CenteredOnViewer or EOvrLeaderboardStartAt::CenteredOnViewerOrTop, then the current user's ID will be automatically added to the query.
UserIDs
- Defines a list of user ids to get entries for.
UserIDLength
- The number of user IDs provided.
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.
Parameters
ChallengeOptions
- This indicates the options of the challenge and it can be retrieved by FOvrChallengeOptions.
Limit
- Sets a limit on the maximum number of challenges to be fetched, which can be useful for pagination or performance reasons.
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.
Parameters
ChallengeID
- The ID of challenge that the user is going to join. It can be retrieved by 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.
Parameters
ChallengeID
- The ID of challenge that the user is going to leave. It can be retrieved by field FOvrChallenge::ID.
Deprecated
Use server-to-server API call instead.
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 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.
Parameters
VideoTitle
- A string representing the title of the video being played in the cowatching session. This parameter must not exceed 100 characters in length.
PresenterData
- A string containing data that drives the cowatching session, such as video metadata or playback information. This parameter is limited to 500 characters in length and will be eventually consistent across all users participating in the session.
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.
Parameters
ViewerData
- A string containing data about the current user's viewer state, such as their preferences or settings. This data is shared with copresent users during an active cowatching session and is limited to 500 characters in size. The data will eventually become consistent across all users participating in the 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). See more details here.
Parameters
ChallengeNonce
- A string that represents a nonce value used to generate the attestation token, ensuring uniqueness and security.
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.
Parameters
Options
- It contains two methods. 1. Add FOvrInviteOptions::SuggestedUsers - Takes the userID as a parameter and adds it to the inevitable users list. 2. Clear FOvrInviteOptions::SuggestedUsers - Clears the inevitable users list.
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.
Parameters
Options
- It contains a FOvrMultiplayerErrorOptions::ErrorKey associated with the predefined error message to be shown to users.
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.
Parameters
LobbySessionId
- The unique identifier of the lobby session to rejoin.
MatchSessionId
- The unique identifier of the match session to rejoin.
DestinationApiName
- The unique name of the in-app destination to rejoin.
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.
Parameters
Options
- It contains 2 methods. 1. Add FOvrRosterOptions::SuggestedUsers - it takes userID as a parameter and adds it to the inevitable users list. 2.Clear FOvrRosterOptions::SuggestedUsers - it clears the inevitable users list.
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 GroupPresence_GetInvitableUsers(). This API works as an alternative to GroupPresence_LaunchInvitePanel() which delegates the invite flow to the system invite module. GroupPresence_LaunchInvitePanel() is the recommended approach.
Parameters
UserIDs
- userIDs is a list of users’ ids to send invites to.
UserIDLength
- The number of user IDs provided.
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.
Parameters
GroupPresenceOptions
- The groupPresenceOptions parameter contains five methods. 1. FOvrGroupPresenceOptions::DeeplinkMessageOverride - Use FOvrGroupPresenceOptions::LobbySessionId or FOvrGroupPresenceOptions::MatchSessionId to specify the session. Use the FOvrGroupPresenceOptions::DeeplinkMessageOverride for any additional data in whatever format you wish to aid in bringing users together. If not specified, the deeplink_message for the user will default to the one on the destination. 2.FOvrGroupPresenceOptions::DestinationApiName - This the unique API Name that refers to an in-app destination. 3.FOvrGroupPresenceOptions::IsJoinable - Set whether or not the person is shown as joinable or not to others. A user that is joinable can invite others to join them. Set this to false if other users would not be able to join this user. For example, the current session is full, or only the host can invite others and the current user is not the host. 4.FOvrGroupPresenceOptions::LobbySessionId - This is a session that represents a closer group/squad/party of users. It is expected that all users with the same lobby session id can see or hear each other. Users with the same lobby session id in their group presence will show up in the roster and will show up as "Recently Played With" for future invites if they aren't already Oculus friends. This must be set in addition to FOvrGroupPresenceOptions::IsJoinable being true for a user to use invites. 5.FOvrGroupPresenceOptions::MatchSessionId - This is a session that represents all the users that are playing a specific instance of a map, game mode, round, etc. This can include users from multiple different lobbies that joined together and the users may or may not remain together after the match is over. Users with the same match session id in their group presence will not show up in the Roster, but will show up as "Recently Played with" for future invites.
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 GroupPresence_Set().
Parameters
DeeplinkMessage
- deeplink_message is the new FOvrGroupPresenceOptions::DeeplinkMessageOverride to set for the user, overriding the current deeplink message.
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 GroupPresence_Set(). This helps ensure that all relevant presence information is singularly updated and helps reduce presence errors.
Parameters
ApiName
- api_name is the unique name of the in-app desination to set, replacing the user's current FOvrGroupPresenceOptions::DestinationApiName.
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 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.
Parameters
IsJoinable
- If FOvrGroupPresenceOptions::IsJoinable is true, the user can invite others to join them. If false, other users cannot join this user, for example, if the current session is full or only the host can invite others and the current user is not the host.
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 GroupPresence_Set(). This helps ensure that all relevant presence information is singularly updated and helps reduce presence errors.
Parameters
Id
- id is the unique identifier of the lobby session to set, replacing the user's current FOvrGroupPresenceOptions::LobbySessionId.
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 GroupPresence_Set().
Parameters
Id
- id is the unique identifier of the match session to set, replacing the user's current FOvrGroupPresenceOptions::MatchSessionId.
Allow the consumable IAP product to be purchased again. Conceptually, this indicates that the item was used or consumed.
Parameters
Sku
- The SKU of the product 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.
Parameters
Skus
- The SKUs of the products to retrieve.
Count
- Number of items you provided in the SKUs.
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 resolve it, if possible. Returns a purchase on success, empty purchase on cancel, and an error on error.
Parameters
Sku
- IAP sku for the item the user wishes to purchase.
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 AssetFile_DownloadByName() request, and sends periodic FOvrNotification_AssetFile_DownloadUpdate to track the downloads. Once the language asset file is downloaded, call LanguagePack_GetCurrent() to retrieve the data, and use the language at runtime.
Parameters
Tag
- The BCP47 language tag that identifies the language to be set as the current language.
Gets the information for a single leaderboard
Parameters
LeaderboardName
- The name of the leaderboard to return.
Requests a block of leaderboard entries.
Parameters
LeaderboardName
- The name of the leaderboard whose entries to return.
Limit
- Defines the maximum number of entries to return.
Filter
- By using ovrLeaderboard_FilterFriends, this allows you to filter the returned values to bidirectional followers.
StartAt
- Defines whether to center the query on the user or start at the top of the leaderboard.
Requests a block of leaderboard entries.
Parameters
LeaderboardName
- The name of the leaderboard.
Limit
- The maximum number of entries to return.
AfterRank
- The position after which to start. For example, 10 returns leaderboard results starting with the 11th user.
Requests a block of leaderboard entries. Will return only entries matching the user IDs passed in.
Parameters
LeaderboardName
- The name of the leaderboard whose entries to return.
Limit
- Defines the maximum number of entries to return.
StartAt
- Defines whether to center the query on the user or start at the top of the leaderboard. If this is EOvrLeaderboardStartAt::CenteredOnViewer or EOvrLeaderboardStartAt::CenteredOnViewerOrTop, then the current user's ID will be automatically added to the query.
UserIDs
- Defines a list of user ids to get entries for.
UserIDLength
- The number of user IDs provided.
Writes a single entry to a leaderboard.
Parameters
LeaderboardName
- The leaderboard for which to write the entry.
Score
- The score to write.
ExtraData
- A 2KB custom data field that is associated with the leaderboard entry. This can be a game replay or anything that provides more detail about the entry to the viewer.
ExtraDataLength
- The length of the extra data.
ForceUpdate
- If true, the score always updates. This happens even if it is not the user's best score.
Writes a single entry to a leaderboard, can include supplementary metrics
Parameters
LeaderboardName
- The leaderboard for which to write the entry.
Score
- The score to write.
SupplementaryMetric
- A metric that can be used for tiebreakers.
ExtraData
- A 2KB custom data field that is associated with the leaderboard entry. This can be a game replay or anything that provides more detail about the entry to the viewer.
ExtraDataLength
- The length of the extra data.
ForceUpdate
- If true, the score always updates. This happens even if it is not the user's best score.
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.
Parameters
PostTextSuggestion
- this text will prepopulate the facebook status text-input box within the share modal
FilePath
- path to the file to be shared to facebook
ContentType
- content type of the media to be shared
Mark a notification as read. This causes it to disappear from the Universal Menu, the Oculus App, Oculus Home, and in-app retrieval.
Load the party the current user is in.
Deprecated
Use the clear method in group presence
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.
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
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.
Parameters
UserID
- The id of the user that we are going to get its org scoped ID FOvrOrgScopedID.
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 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.
Parameters
UserID
- The ID of the user that the viewer is going to laucnh 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.
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.
Parameters
AgeCategory
- Age category for developers to send to Meta. There are two members, children age group (EOvrAppAgeCategory::Ch) and non-children age group (EOvrAppAgeCategory::Nch).
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.

Member Functions

Deprecated
Use GroupPresence_Set().
Did you find this page helpful?
Thumbs up icon
Thumbs down icon
Nav Logo
Virtual reality / Meta Horizon
Virtual reality / Meta Horizon
Virtual reality / Meta Horizon
English (US)
© 2025 Meta