API reference

UOvrRequestsBlueprintLibrary Class

Extends UBlueprintFunctionLibrary
The UOvrRequestsBlueprintLibrary 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 Solutions here.

Fields

AssetDetails : EOvrRequestOutputPins FLatentActionInfo FOvrIdFOvrAssetDetails &
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.
Signature
EOvrRequestOutputPins FLatentActionInfo FOvrId FOvrAssetDetails& UOvrRequestsBlueprintLibrary::AssetDetails
AssetFileDeleteResult : EOvrRequestOutputPins FLatentActionInfo FOvrIdFOvrAssetFileDeleteResult &
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.
Signature
EOvrRequestOutputPins FLatentActionInfo FOvrId FOvrAssetFileDeleteResult& UOvrRequestsBlueprintLibrary::AssetFileDeleteResult
AssetFileDownloadCancelResult : EOvrRequestOutputPins FLatentActionInfo FOvrIdFOvrAssetFileDownloadCancelResult &
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.
Signature
EOvrRequestOutputPins FLatentActionInfo FOvrId FOvrAssetFileDownloadCancelResult& UOvrRequestsBlueprintLibrary::AssetFileDownloadCancelResult
AssetFileDownloadResult : EOvrRequestOutputPins FLatentActionInfo FOvrIdFOvrAssetFileDownloadResult &
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.
Signature
EOvrRequestOutputPins FLatentActionInfo FOvrId FOvrAssetFileDownloadResult& UOvrRequestsBlueprintLibrary::AssetFileDownloadResult
AssetFileID : EOvrRequestOutputPins FLatentActionInfo FOvrId
The uuid of the asset file.
The uuid of the file.
Signature
EOvrRequestOutputPins FLatentActionInfo FOvrId UOvrRequestsBlueprintLibrary::AssetFileID
ErrorMsg : EOvrRequestOutputPins FLatentActionInfo FOvrIdFOvrAssetFileDeleteResult FString &
Error message if the request failed, which contains failure reason, it is empty if the request succeeded.
Signature
EOvrRequestOutputPins FLatentActionInfo FOvrId FOvrAssetFileDeleteResult FString& UOvrRequestsBlueprintLibrary::ErrorMsg
ErrorMsg : EOvrRequestOutputPins FLatentActionInfo FOvrIdFOvrAssetFileDownloadResult FString &
Error message if the request failed, which contains failure reason, it is empty if the request succeeded.
Signature
EOvrRequestOutputPins FLatentActionInfo FOvrId FOvrAssetFileDownloadResult FString& UOvrRequestsBlueprintLibrary::ErrorMsg
ErrorMsg : EOvrRequestOutputPins FLatentActionInfo FOvrIdFOvrAssetFileDownloadCancelResult FString &
Error message if the request failed, which contains failure reason, it is empty if the request succeeded.
Signature
EOvrRequestOutputPins FLatentActionInfo FOvrId FOvrAssetFileDownloadCancelResult FString& UOvrRequestsBlueprintLibrary::ErrorMsg
ErrorMsg : EOvrRequestOutputPins FLatentActionInfo FOvrIdFOvrAssetDetails FString &
Error message if the request failed, which contains failure reason, it is empty if the request succeeded.
Signature
EOvrRequestOutputPins FLatentActionInfo FOvrId FOvrAssetDetails FString& UOvrRequestsBlueprintLibrary::ErrorMsg
ErrorMsg : EOvrRequestOutputPins FLatentActionInfo FString &
Error message if the request failed, which contains failure reason, it is empty if the request succeeded.
Signature
EOvrRequestOutputPins FLatentActionInfo FString& UOvrRequestsBlueprintLibrary::ErrorMsg
ErrorMsg : EOvrRequestOutputPins FLatentActionInfo FOvrRichPresenceOptions FString &
Error message if the request failed, which contains failure reason, it is empty if the request succeeded.
Signature
EOvrRequestOutputPins FLatentActionInfo FOvrRichPresenceOptions FString& UOvrRequestsBlueprintLibrary::ErrorMsg
LatentInfo : EOvrRequestOutputPins FLatentActionInfo
Information about the latent action that will be performed as a result of this request.
Signature
EOvrRequestOutputPins FLatentActionInfo UOvrRequestsBlueprintLibrary::LatentInfo
OutExecs : EOvrRequestOutputPins &
Reference to an array of output pins that will be executed as a result of this request.
Signature
EOvrRequestOutputPins & UOvrRequestsBlueprintLibrary::OutExecs
RichPresenceOptions : EOvrRequestOutputPins FLatentActionInfo FOvrRichPresenceOptions
The options of the rich presence.
Signature
EOvrRequestOutputPins FLatentActionInfo FOvrRichPresenceOptions UOvrRequestsBlueprintLibrary::RichPresenceOptions

Member Functions

UFUNCTION ()
Word context.
Signature
UOvrRequestsBlueprintLibrary::UFUNCTION(BlueprintCallable, meta=(DeprecatedFunction, DeprecationMessage="Use UOvrRequestsBlueprintLibrary::AssetFile_DeleteById()", Latent, LatentInfo="LatentInfo", WorldContext="WorldContextObject", ExpandEnumAsExecs="OutExecs"), Category="OvrPlatform|AssetFile") static void AssetFile_Delete(UObject *WorldContextObject
Parameters
BlueprintCallable
meta
Category
UFUNCTION ()
Word context.
Signature
UOvrRequestsBlueprintLibrary::UFUNCTION(BlueprintCallable, meta=(DeprecatedFunction, DeprecationMessage="Use UOvrRequestsBlueprintLibrary::AssetFile_DownloadById()", Latent, LatentInfo="LatentInfo", WorldContext="WorldContextObject", ExpandEnumAsExecs="OutExecs"), Category="OvrPlatform|AssetFile") static void AssetFile_Download(UObject *WorldContextObject
Parameters
BlueprintCallable
meta
Category
UFUNCTION ()
Word context.
Signature
UOvrRequestsBlueprintLibrary::UFUNCTION(BlueprintCallable, meta=(DeprecatedFunction, DeprecationMessage="Use UOvrRequestsBlueprintLibrary::AssetFile_DownloadCancelById()", Latent, LatentInfo="LatentInfo", WorldContext="WorldContextObject", ExpandEnumAsExecs="OutExecs"), Category="OvrPlatform|AssetFile") static void AssetFile_DownloadCancel(UObject *WorldContextObject
Parameters
BlueprintCallable
meta
Category
UFUNCTION ()
Word context.
Signature
UOvrRequestsBlueprintLibrary::UFUNCTION(BlueprintCallable, meta=(DeprecatedFunction, DeprecationMessage="Use UOvrRequestsBlueprintLibrary::AssetFile_StatusById()", Latent, LatentInfo="LatentInfo", WorldContext="WorldContextObject", ExpandEnumAsExecs="OutExecs"), Category="OvrPlatform|AssetFile") static void AssetFile_Status(UObject *WorldContextObject
Parameters
BlueprintCallable
meta
Category
UFUNCTION ()
Word context.
Signature
UOvrRequestsBlueprintLibrary::UFUNCTION(BlueprintCallable, meta=(DeprecatedFunction, DeprecationMessage="Use UOvrRequestsBlueprintLibrary::GroupPresence_Clear()", Latent, LatentInfo="LatentInfo", WorldContext="WorldContextObject", ExpandEnumAsExecs="OutExecs"), Category="OvrPlatform|RichPresence") static void RichPresence_Clear(UObject *WorldContextObject
Parameters
BlueprintCallable
meta
Category
UFUNCTION ()
Word context.
Signature
UOvrRequestsBlueprintLibrary::UFUNCTION(BlueprintCallable, meta=(DeprecatedFunction, DeprecationMessage="Use UOvrRequestsBlueprintLibrary::GroupPresence_Set().", Latent, LatentInfo="LatentInfo", WorldContext="WorldContextObject", ExpandEnumAsExecs="OutExecs"), Category="OvrPlatform|RichPresence") static void RichPresence_Set(UObject *WorldContextObject
Parameters
BlueprintCallable
meta
Category

Static Member Functions

AbuseReport_ReportRequestHandled ( WorldContextObject , OutExecs , LatentInfo , Response , ErrorMsg )
The currently running application has indicated they want to show their in-app reporting flow or that they choose to ignore the request.
Signature
static void UOvrRequestsBlueprintLibrary::AbuseReport_ReportRequestHandled(UObject *WorldContextObject, EOvrRequestOutputPins &OutExecs, FLatentActionInfo LatentInfo, EOvrReportRequestResponse Response, FString &ErrorMsg)
Parameters
WorldContextObject: UObject *
LatentInfo: FLatentActionInfo
ErrorMsg: FString &
Returns
void
Achievements_AddCount ( WorldContextObject , OutExecs , LatentInfo , Name , Count , AchievementUpdate , ErrorMsg )
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.
Signature
static void UOvrRequestsBlueprintLibrary::Achievements_AddCount(UObject *WorldContextObject, EOvrRequestOutputPins &OutExecs, FLatentActionInfo LatentInfo, FString Name, int64 Count, FOvrAchievementUpdate &AchievementUpdate, FString &ErrorMsg)
Parameters
WorldContextObject: UObject *
LatentInfo: FLatentActionInfo
Name: FString
Count: int64
AchievementUpdate: FOvrAchievementUpdate &
ErrorMsg: FString &
Returns
void
Achievements_AddFields ( WorldContextObject , OutExecs , LatentInfo , Name , Fields , AchievementUpdate , ErrorMsg )
Unlock fields of a BITFIELD achievement.
Signature
static void UOvrRequestsBlueprintLibrary::Achievements_AddFields(UObject *WorldContextObject, EOvrRequestOutputPins &OutExecs, FLatentActionInfo LatentInfo, FString Name, FString Fields, FOvrAchievementUpdate &AchievementUpdate, FString &ErrorMsg)
Parameters
WorldContextObject: UObject *
LatentInfo: FLatentActionInfo
Name: FString
Fields: FString
AchievementUpdate: FOvrAchievementUpdate &
ErrorMsg: FString &
Returns
void
Achievements_GetAllDefinitions ( WorldContextObject , OutExecs , LatentInfo , AchievementDefinitionPages , ErrorMsg )
Retrieve all achievement definitions for the app, including their name, unlock requirements, and any additional details.
Signature
static void UOvrRequestsBlueprintLibrary::Achievements_GetAllDefinitions(UObject *WorldContextObject, EOvrRequestOutputPins &OutExecs, FLatentActionInfo LatentInfo, FOvrAchievementDefinitionPages &AchievementDefinitionPages, FString &ErrorMsg)
Parameters
WorldContextObject: UObject *
LatentInfo: FLatentActionInfo
AchievementDefinitionPages: FOvrAchievementDefinitionPages &
ErrorMsg: FString &
Returns
void
Achievements_GetAllProgress ( WorldContextObject , OutExecs , LatentInfo , AchievementProgressPages , ErrorMsg )
Retrieve the progress for the user on all achievements in the app.
Signature
static void UOvrRequestsBlueprintLibrary::Achievements_GetAllProgress(UObject *WorldContextObject, EOvrRequestOutputPins &OutExecs, FLatentActionInfo LatentInfo, FOvrAchievementProgressPages &AchievementProgressPages, FString &ErrorMsg)
Parameters
WorldContextObject: UObject *
LatentInfo: FLatentActionInfo
AchievementProgressPages: FOvrAchievementProgressPages &
ErrorMsg: FString &
Returns
void
Achievements_GetDefinitionsByName ( WorldContextObject , OutExecs , LatentInfo , Names , AchievementDefinitionPages , ErrorMsg )
Retrieve the achievement definitions that match the specified names, including their name, unlock requirements, and any additional details.
Signature
static void UOvrRequestsBlueprintLibrary::Achievements_GetDefinitionsByName(UObject *WorldContextObject, EOvrRequestOutputPins &OutExecs, FLatentActionInfo LatentInfo, TArray< FString > Names, FOvrAchievementDefinitionPages &AchievementDefinitionPages, FString &ErrorMsg)
Parameters
WorldContextObject: UObject *
LatentInfo: FLatentActionInfo
Names: TArray< FString >
AchievementDefinitionPages: FOvrAchievementDefinitionPages &
ErrorMsg: FString &
Returns
void
Achievements_GetProgressByName ( WorldContextObject , OutExecs , LatentInfo , Names , AchievementProgressPages , ErrorMsg )
Retrieve the user's progress on the achievements that match the specified names.
Signature
static void UOvrRequestsBlueprintLibrary::Achievements_GetProgressByName(UObject *WorldContextObject, EOvrRequestOutputPins &OutExecs, FLatentActionInfo LatentInfo, TArray< FString > Names, FOvrAchievementProgressPages &AchievementProgressPages, FString &ErrorMsg)
Parameters
WorldContextObject: UObject *
LatentInfo: FLatentActionInfo
Names: TArray< FString >
AchievementProgressPages: FOvrAchievementProgressPages &
ErrorMsg: FString &
Returns
void
Achievements_Unlock ( WorldContextObject , OutExecs , LatentInfo , Name , AchievementUpdate , ErrorMsg )
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.
Signature
static void UOvrRequestsBlueprintLibrary::Achievements_Unlock(UObject *WorldContextObject, EOvrRequestOutputPins &OutExecs, FLatentActionInfo LatentInfo, FString Name, FOvrAchievementUpdate &AchievementUpdate, FString &ErrorMsg)
Parameters
WorldContextObject: UObject *
LatentInfo: FLatentActionInfo
Name: FString
AchievementUpdate: FOvrAchievementUpdate &
ErrorMsg: FString &
Returns
void
Application_CancelAppDownload ( WorldContextObject , OutExecs , LatentInfo , AppDownloadResult , ErrorMsg )
Cancel an app download that is in progress. It will return a result when the download is cancelled.
Signature
static void UOvrRequestsBlueprintLibrary::Application_CancelAppDownload(UObject *WorldContextObject, EOvrRequestOutputPins &OutExecs, FLatentActionInfo LatentInfo, FOvrAppDownloadResult &AppDownloadResult, FString &ErrorMsg)
Parameters
WorldContextObject: UObject *
LatentInfo: FLatentActionInfo
AppDownloadResult: FOvrAppDownloadResult &
ErrorMsg: FString &
Returns
void
Application_CheckAppDownloadProgress ( WorldContextObject , OutExecs , LatentInfo , AppDownloadProgressResult , ErrorMsg )
Track download progress for an app.
Signature
static void UOvrRequestsBlueprintLibrary::Application_CheckAppDownloadProgress(UObject *WorldContextObject, EOvrRequestOutputPins &OutExecs, FLatentActionInfo LatentInfo, FOvrAppDownloadProgressResult &AppDownloadProgressResult, FString &ErrorMsg)
Parameters
WorldContextObject: UObject *
LatentInfo: FLatentActionInfo
AppDownloadProgressResult: FOvrAppDownloadProgressResult &
ErrorMsg: FString &
Returns
void
Application_GetVersion ( WorldContextObject , OutExecs , LatentInfo , ApplicationVersion , ErrorMsg )
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.
Signature
static void UOvrRequestsBlueprintLibrary::Application_GetVersion(UObject *WorldContextObject, EOvrRequestOutputPins &OutExecs, FLatentActionInfo LatentInfo, FOvrApplicationVersion &ApplicationVersion, FString &ErrorMsg)
Parameters
WorldContextObject: UObject *
LatentInfo: FLatentActionInfo
ApplicationVersion: FOvrApplicationVersion &
ErrorMsg: FString &
Returns
void
Application_InstallAppUpdateAndRelaunch ( WorldContextObject , OutExecs , LatentInfo , DeeplinkOptions , AppDownloadResult , ErrorMsg )
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.
Signature
static void UOvrRequestsBlueprintLibrary::Application_InstallAppUpdateAndRelaunch(UObject *WorldContextObject, EOvrRequestOutputPins &OutExecs, FLatentActionInfo LatentInfo, FOvrApplicationOptions DeeplinkOptions, FOvrAppDownloadResult &AppDownloadResult, FString &ErrorMsg)
Parameters
WorldContextObject: UObject *
LatentInfo: FLatentActionInfo
DeeplinkOptions: FOvrApplicationOptions
AppDownloadResult: FOvrAppDownloadResult &
ErrorMsg: FString &
Returns
void
Application_LaunchOtherApp ( WorldContextObject , OutExecs , LatentInfo , AppID , DeeplinkOptions , StringPayload , ErrorMsg )
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
Signature
static void UOvrRequestsBlueprintLibrary::Application_LaunchOtherApp(UObject *WorldContextObject, EOvrRequestOutputPins &OutExecs, FLatentActionInfo LatentInfo, FOvrId AppID, FOvrApplicationOptions DeeplinkOptions, FString &StringPayload, FString &ErrorMsg)
Parameters
WorldContextObject: UObject *
LatentInfo: FLatentActionInfo
AppID: FOvrId
DeeplinkOptions: FOvrApplicationOptions
StringPayload: FString &
ErrorMsg: FString &
Returns
void
Application_StartAppDownload ( WorldContextObject , OutExecs , LatentInfo , AppDownloadResult , ErrorMsg )
Starts an app download. It will return a result when the download is finished. Download progress can be monitored using the UOvrRequestsBlueprintLibrary::Application_CheckAppDownloadProgress().
Signature
static void UOvrRequestsBlueprintLibrary::Application_StartAppDownload(UObject *WorldContextObject, EOvrRequestOutputPins &OutExecs, FLatentActionInfo LatentInfo, FOvrAppDownloadResult &AppDownloadResult, FString &ErrorMsg)
Parameters
WorldContextObject: UObject *
LatentInfo: FLatentActionInfo
AppDownloadResult: FOvrAppDownloadResult &
ErrorMsg: FString &
Returns
void
AssetFile_DeleteById ( WorldContextObject , OutExecs , LatentInfo , AssetFileID , AssetFileDeleteResult , ErrorMsg )
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.
Signature
static void UOvrRequestsBlueprintLibrary::AssetFile_DeleteById(UObject *WorldContextObject, EOvrRequestOutputPins &OutExecs, FLatentActionInfo LatentInfo, FOvrId AssetFileID, FOvrAssetFileDeleteResult &AssetFileDeleteResult, FString &ErrorMsg)
Parameters
WorldContextObject: UObject *
LatentInfo: FLatentActionInfo
AssetFileID: FOvrId
AssetFileDeleteResult: FOvrAssetFileDeleteResult &
ErrorMsg: FString &
Returns
void
AssetFile_DeleteByName ( WorldContextObject , OutExecs , LatentInfo , AssetFileName , AssetFileDeleteResult , ErrorMsg )
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.
Signature
static void UOvrRequestsBlueprintLibrary::AssetFile_DeleteByName(UObject *WorldContextObject, EOvrRequestOutputPins &OutExecs, FLatentActionInfo LatentInfo, FString AssetFileName, FOvrAssetFileDeleteResult &AssetFileDeleteResult, FString &ErrorMsg)
Parameters
WorldContextObject: UObject *
LatentInfo: FLatentActionInfo
AssetFileName: FString
AssetFileDeleteResult: FOvrAssetFileDeleteResult &
ErrorMsg: FString &
Returns
void
AssetFile_DownloadById ( WorldContextObject , OutExecs , LatentInfo , AssetFileID , AssetFileDownloadResult , ErrorMsg )
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.
Signature
static void UOvrRequestsBlueprintLibrary::AssetFile_DownloadById(UObject *WorldContextObject, EOvrRequestOutputPins &OutExecs, FLatentActionInfo LatentInfo, FOvrId AssetFileID, FOvrAssetFileDownloadResult &AssetFileDownloadResult, FString &ErrorMsg)
Parameters
WorldContextObject: UObject *
LatentInfo: FLatentActionInfo
AssetFileID: FOvrId
AssetFileDownloadResult: FOvrAssetFileDownloadResult &
ErrorMsg: FString &
Returns
void
AssetFile_DownloadByName ( WorldContextObject , OutExecs , LatentInfo , AssetFileName , AssetFileDownloadResult , ErrorMsg )
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.
Signature
static void UOvrRequestsBlueprintLibrary::AssetFile_DownloadByName(UObject *WorldContextObject, EOvrRequestOutputPins &OutExecs, FLatentActionInfo LatentInfo, FString AssetFileName, FOvrAssetFileDownloadResult &AssetFileDownloadResult, FString &ErrorMsg)
Parameters
WorldContextObject: UObject *
LatentInfo: FLatentActionInfo
AssetFileName: FString
AssetFileDownloadResult: FOvrAssetFileDownloadResult &
ErrorMsg: FString &
Returns
void
AssetFile_DownloadCancelById ( WorldContextObject , OutExecs , LatentInfo , AssetFileID , AssetFileDownloadCancelResult , ErrorMsg )
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.
Signature
static void UOvrRequestsBlueprintLibrary::AssetFile_DownloadCancelById(UObject *WorldContextObject, EOvrRequestOutputPins &OutExecs, FLatentActionInfo LatentInfo, FOvrId AssetFileID, FOvrAssetFileDownloadCancelResult &AssetFileDownloadCancelResult, FString &ErrorMsg)
Parameters
WorldContextObject: UObject *
LatentInfo: FLatentActionInfo
AssetFileID: FOvrId
AssetFileDownloadCancelResult: FOvrAssetFileDownloadCancelResult &
ErrorMsg: FString &
Returns
void
AssetFile_DownloadCancelByName ( WorldContextObject , OutExecs , LatentInfo , AssetFileName , AssetFileDownloadCancelResult , ErrorMsg )
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.
Signature
static void UOvrRequestsBlueprintLibrary::AssetFile_DownloadCancelByName(UObject *WorldContextObject, EOvrRequestOutputPins &OutExecs, FLatentActionInfo LatentInfo, FString AssetFileName, FOvrAssetFileDownloadCancelResult &AssetFileDownloadCancelResult, FString &ErrorMsg)
Parameters
WorldContextObject: UObject *
LatentInfo: FLatentActionInfo
AssetFileName: FString
AssetFileDownloadCancelResult: FOvrAssetFileDownloadCancelResult &
ErrorMsg: FString &
Returns
void
AssetFile_GetList ( WorldContextObject , OutExecs , LatentInfo , AssetDetailsArray , ErrorMsg )
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.
Signature
static void UOvrRequestsBlueprintLibrary::AssetFile_GetList(UObject *WorldContextObject, EOvrRequestOutputPins &OutExecs, FLatentActionInfo LatentInfo, TArray< FOvrAssetDetails > &AssetDetailsArray, FString &ErrorMsg)
Parameters
WorldContextObject: UObject *
LatentInfo: FLatentActionInfo
AssetDetailsArray: TArray< FOvrAssetDetails > &
ErrorMsg: FString &
Returns
void
AssetFile_StatusById ( WorldContextObject , OutExecs , LatentInfo , AssetFileID , AssetDetails , ErrorMsg )
Returns the details FOvrAssetDetails on a single asset: ID, file name, and whether it's currently installed
Signature
static void UOvrRequestsBlueprintLibrary::AssetFile_StatusById(UObject *WorldContextObject, EOvrRequestOutputPins &OutExecs, FLatentActionInfo LatentInfo, FOvrId AssetFileID, FOvrAssetDetails &AssetDetails, FString &ErrorMsg)
Parameters
WorldContextObject: UObject *
LatentInfo: FLatentActionInfo
AssetFileID: FOvrId
AssetDetails: FOvrAssetDetails &
ErrorMsg: FString &
Returns
void
AssetFile_StatusByName ( WorldContextObject , OutExecs , LatentInfo , AssetFileName , AssetDetails , ErrorMsg )
Returns the details FOvrAssetDetails on a single asset: ID, file name, and whether it's currently installed
Signature
static void UOvrRequestsBlueprintLibrary::AssetFile_StatusByName(UObject *WorldContextObject, EOvrRequestOutputPins &OutExecs, FLatentActionInfo LatentInfo, FString AssetFileName, FOvrAssetDetails &AssetDetails, FString &ErrorMsg)
Parameters
WorldContextObject: UObject *
LatentInfo: FLatentActionInfo
AssetFileName: FString
AssetDetails: FOvrAssetDetails &
ErrorMsg: FString &
Returns
void
Avatar_LaunchAvatarEditor ( WorldContextObject , OutExecs , LatentInfo , Options , AvatarEditorResult , ErrorMsg )
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.
Signature
static void UOvrRequestsBlueprintLibrary::Avatar_LaunchAvatarEditor(UObject *WorldContextObject, EOvrRequestOutputPins &OutExecs, FLatentActionInfo LatentInfo, FOvrAvatarEditorOptions Options, FOvrAvatarEditorResult &AvatarEditorResult, FString &ErrorMsg)
Parameters
WorldContextObject: UObject *
LatentInfo: FLatentActionInfo
AvatarEditorResult: FOvrAvatarEditorResult &
ErrorMsg: FString &
Returns
void
Challenges_Create ( WorldContextObject , OutExecs , LatentInfo , LeaderboardName , ChallengeOptions , Challenge , ErrorMsg )
DeprecatedUse server-to-server API call instead.
Signature
static void UOvrRequestsBlueprintLibrary::Challenges_Create(UObject *WorldContextObject, EOvrRequestOutputPins &OutExecs, FLatentActionInfo LatentInfo, FString LeaderboardName, FOvrChallengeOptions ChallengeOptions, FOvrChallenge &Challenge, FString &ErrorMsg)
Parameters
WorldContextObject: UObject *
LatentInfo: FLatentActionInfo
LeaderboardName: FString
ChallengeOptions: FOvrChallengeOptions
Challenge: FOvrChallenge &
ErrorMsg: FString &
Returns
void
Challenges_DeclineInvite ( WorldContextObject , OutExecs , LatentInfo , ChallengeID , Challenge , ErrorMsg )
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.
Signature
static void UOvrRequestsBlueprintLibrary::Challenges_DeclineInvite(UObject *WorldContextObject, EOvrRequestOutputPins &OutExecs, FLatentActionInfo LatentInfo, FOvrId ChallengeID, FOvrChallenge &Challenge, FString &ErrorMsg)
Parameters
WorldContextObject: UObject *
LatentInfo: FLatentActionInfo
ChallengeID: FOvrId
Challenge: FOvrChallenge &
ErrorMsg: FString &
Returns
void
Challenges_Delete ( WorldContextObject , OutExecs , LatentInfo , ChallengeID , ErrorMsg )
DeprecatedUse server-to-server API call instead.
Signature
static void UOvrRequestsBlueprintLibrary::Challenges_Delete(UObject *WorldContextObject, EOvrRequestOutputPins &OutExecs, FLatentActionInfo LatentInfo, FOvrId ChallengeID, FString &ErrorMsg)
Parameters
WorldContextObject: UObject *
LatentInfo: FLatentActionInfo
ChallengeID: FOvrId
ErrorMsg: FString &
Returns
void
Challenges_Get ( WorldContextObject , OutExecs , LatentInfo , ChallengeID , Challenge , ErrorMsg )
Gets detailed information for a single challenge by providing the challenge ID, which can be retrieved by calling field FOvrChallenge::ID.
Signature
static void UOvrRequestsBlueprintLibrary::Challenges_Get(UObject *WorldContextObject, EOvrRequestOutputPins &OutExecs, FLatentActionInfo LatentInfo, FOvrId ChallengeID, FOvrChallenge &Challenge, FString &ErrorMsg)
Parameters
WorldContextObject: UObject *
LatentInfo: FLatentActionInfo
ChallengeID: FOvrId
Challenge: FOvrChallenge &
ErrorMsg: FString &
Returns
void
Challenges_GetEntries ( WorldContextObject , OutExecs , LatentInfo , ChallengeID , Limit , Filter , StartAt , ChallengeEntryPages , ErrorMsg )
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.
Signature
static void UOvrRequestsBlueprintLibrary::Challenges_GetEntries(UObject *WorldContextObject, EOvrRequestOutputPins &OutExecs, FLatentActionInfo LatentInfo, FOvrId ChallengeID, int32 Limit, EOvrLeaderboardFilterType Filter, EOvrLeaderboardStartAt StartAt, FOvrChallengeEntryPages &ChallengeEntryPages, FString &ErrorMsg)
Parameters
WorldContextObject: UObject *
LatentInfo: FLatentActionInfo
ChallengeID: FOvrId
Limit: int32
ChallengeEntryPages: FOvrChallengeEntryPages &
ErrorMsg: FString &
Returns
void
Challenges_GetEntriesAfterRank ( WorldContextObject , OutExecs , LatentInfo , ChallengeID , Limit , AfterRank , ChallengeEntryPages , ErrorMsg )
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.
Signature
static void UOvrRequestsBlueprintLibrary::Challenges_GetEntriesAfterRank(UObject *WorldContextObject, EOvrRequestOutputPins &OutExecs, FLatentActionInfo LatentInfo, FOvrId ChallengeID, int32 Limit, int64 AfterRank, FOvrChallengeEntryPages &ChallengeEntryPages, FString &ErrorMsg)
Parameters
WorldContextObject: UObject *
LatentInfo: FLatentActionInfo
ChallengeID: FOvrId
Limit: int32
AfterRank: int64
ChallengeEntryPages: FOvrChallengeEntryPages &
ErrorMsg: FString &
Returns
void
Challenges_GetEntriesByIds ( WorldContextObject , OutExecs , LatentInfo , ChallengeID , Limit , StartAt , UserIDs , ChallengeEntryPages , ErrorMsg )
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.
Signature
static void UOvrRequestsBlueprintLibrary::Challenges_GetEntriesByIds(UObject *WorldContextObject, EOvrRequestOutputPins &OutExecs, FLatentActionInfo LatentInfo, FOvrId ChallengeID, int32 Limit, EOvrLeaderboardStartAt StartAt, TArray< FOvrId > UserIDs, FOvrChallengeEntryPages &ChallengeEntryPages, FString &ErrorMsg)
Parameters
WorldContextObject: UObject *
LatentInfo: FLatentActionInfo
ChallengeID: FOvrId
Limit: int32
UserIDs: TArray< FOvrId >
ChallengeEntryPages: FOvrChallengeEntryPages &
ErrorMsg: FString &
Returns
void
Challenges_GetList ( WorldContextObject , OutExecs , LatentInfo , ChallengeOptions , Limit , ChallengePages , ErrorMsg )
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.
Signature
static void UOvrRequestsBlueprintLibrary::Challenges_GetList(UObject *WorldContextObject, EOvrRequestOutputPins &OutExecs, FLatentActionInfo LatentInfo, FOvrChallengeOptions ChallengeOptions, int32 Limit, FOvrChallengePages &ChallengePages, FString &ErrorMsg)
Parameters
WorldContextObject: UObject *
LatentInfo: FLatentActionInfo
ChallengeOptions: FOvrChallengeOptions
Limit: int32
ChallengePages: FOvrChallengePages &
ErrorMsg: FString &
Returns
void
Challenges_Join ( WorldContextObject , OutExecs , LatentInfo , ChallengeID , Challenge , ErrorMsg )
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.
Signature
static void UOvrRequestsBlueprintLibrary::Challenges_Join(UObject *WorldContextObject, EOvrRequestOutputPins &OutExecs, FLatentActionInfo LatentInfo, FOvrId ChallengeID, FOvrChallenge &Challenge, FString &ErrorMsg)
Parameters
WorldContextObject: UObject *
LatentInfo: FLatentActionInfo
ChallengeID: FOvrId
Challenge: FOvrChallenge &
ErrorMsg: FString &
Returns
void
Challenges_Leave ( WorldContextObject , OutExecs , LatentInfo , ChallengeID , Challenge , ErrorMsg )
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.
Signature
static void UOvrRequestsBlueprintLibrary::Challenges_Leave(UObject *WorldContextObject, EOvrRequestOutputPins &OutExecs, FLatentActionInfo LatentInfo, FOvrId ChallengeID, FOvrChallenge &Challenge, FString &ErrorMsg)
Parameters
WorldContextObject: UObject *
LatentInfo: FLatentActionInfo
ChallengeID: FOvrId
Challenge: FOvrChallenge &
ErrorMsg: FString &
Returns
void
Challenges_UpdateInfo ( WorldContextObject , OutExecs , LatentInfo , ChallengeID , ChallengeOptions , Challenge , ErrorMsg )
DeprecatedUse server-to-server API call instead.
Signature
static void UOvrRequestsBlueprintLibrary::Challenges_UpdateInfo(UObject *WorldContextObject, EOvrRequestOutputPins &OutExecs, FLatentActionInfo LatentInfo, FOvrId ChallengeID, FOvrChallengeOptions ChallengeOptions, FOvrChallenge &Challenge, FString &ErrorMsg)
Parameters
WorldContextObject: UObject *
LatentInfo: FLatentActionInfo
ChallengeID: FOvrId
ChallengeOptions: FOvrChallengeOptions
Challenge: FOvrChallenge &
ErrorMsg: FString &
Returns
void
DeviceApplicationIntegrity_GetIntegrityToken ( WorldContextObject , OutExecs , LatentInfo , ChallengeNonce , StringPayload , ErrorMsg )
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.
Signature
static void UOvrRequestsBlueprintLibrary::DeviceApplicationIntegrity_GetIntegrityToken(UObject *WorldContextObject, EOvrRequestOutputPins &OutExecs, FLatentActionInfo LatentInfo, FString ChallengeNonce, FString &StringPayload, FString &ErrorMsg)
Parameters
WorldContextObject: UObject *
LatentInfo: FLatentActionInfo
ChallengeNonce: FString
StringPayload: FString &
ErrorMsg: FString &
Returns
void
Entitlement_GetIsViewerEntitled ( WorldContextObject , OutExecs , LatentInfo , ErrorMsg )
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.
Signature
static void UOvrRequestsBlueprintLibrary::Entitlement_GetIsViewerEntitled(UObject *WorldContextObject, EOvrRequestOutputPins &OutExecs, FLatentActionInfo LatentInfo, FString &ErrorMsg)
Parameters
WorldContextObject: UObject *
LatentInfo: FLatentActionInfo
ErrorMsg: FString &
Returns
void
GroupPresence_Clear ( WorldContextObject , OutExecs , LatentInfo , ErrorMsg )
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.
Signature
static void UOvrRequestsBlueprintLibrary::GroupPresence_Clear(UObject *WorldContextObject, EOvrRequestOutputPins &OutExecs, FLatentActionInfo LatentInfo, FString &ErrorMsg)
Parameters
WorldContextObject: UObject *
LatentInfo: FLatentActionInfo
ErrorMsg: FString &
Returns
void
GroupPresence_GetInvitableUsers ( WorldContextObject , OutExecs , LatentInfo , Options , UserPages , ErrorMsg )
Returns a list of users that can be invited to your current lobby. These are pulled from your bidirectional followers and recently met lists.
Signature
static void UOvrRequestsBlueprintLibrary::GroupPresence_GetInvitableUsers(UObject *WorldContextObject, EOvrRequestOutputPins &OutExecs, FLatentActionInfo LatentInfo, FOvrInviteOptions Options, FOvrUserPages &UserPages, FString &ErrorMsg)
Parameters
WorldContextObject: UObject *
LatentInfo: FLatentActionInfo
UserPages: FOvrUserPages &
ErrorMsg: FString &
Returns
void
GroupPresence_GetSentInvites ( WorldContextObject , OutExecs , LatentInfo , ApplicationInvitePages , ErrorMsg )
Get the application invites which have been sent by the user.
Signature
static void UOvrRequestsBlueprintLibrary::GroupPresence_GetSentInvites(UObject *WorldContextObject, EOvrRequestOutputPins &OutExecs, FLatentActionInfo LatentInfo, FOvrApplicationInvitePages &ApplicationInvitePages, FString &ErrorMsg)
Parameters
WorldContextObject: UObject *
LatentInfo: FLatentActionInfo
ApplicationInvitePages: FOvrApplicationInvitePages &
ErrorMsg: FString &
Returns
void
GroupPresence_LaunchInvitePanel ( WorldContextObject , OutExecs , LatentInfo , Options , InvitePanelResultInfo , ErrorMsg )
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.
Signature
static void UOvrRequestsBlueprintLibrary::GroupPresence_LaunchInvitePanel(UObject *WorldContextObject, EOvrRequestOutputPins &OutExecs, FLatentActionInfo LatentInfo, FOvrInviteOptions Options, FOvrInvitePanelResultInfo &InvitePanelResultInfo, FString &ErrorMsg)
Parameters
WorldContextObject: UObject *
LatentInfo: FLatentActionInfo
InvitePanelResultInfo: FOvrInvitePanelResultInfo &
ErrorMsg: FString &
Returns
void
GroupPresence_LaunchMultiplayerErrorDialog ( WorldContextObject , OutExecs , LatentInfo , Options , ErrorMsg )
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.
Signature
static void UOvrRequestsBlueprintLibrary::GroupPresence_LaunchMultiplayerErrorDialog(UObject *WorldContextObject, EOvrRequestOutputPins &OutExecs, FLatentActionInfo LatentInfo, FOvrMultiplayerErrorOptions Options, FString &ErrorMsg)
Parameters
WorldContextObject: UObject *
LatentInfo: FLatentActionInfo
ErrorMsg: FString &
Returns
void
GroupPresence_LaunchRejoinDialog ( WorldContextObject , OutExecs , LatentInfo , LobbySessionId , MatchSessionId , DestinationApiName , RejoinDialogResult , ErrorMsg )
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.
Signature
static void UOvrRequestsBlueprintLibrary::GroupPresence_LaunchRejoinDialog(UObject *WorldContextObject, EOvrRequestOutputPins &OutExecs, FLatentActionInfo LatentInfo, FString LobbySessionId, FString MatchSessionId, FString DestinationApiName, FOvrRejoinDialogResult &RejoinDialogResult, FString &ErrorMsg)
Parameters
WorldContextObject: UObject *
LatentInfo: FLatentActionInfo
LobbySessionId: FString
MatchSessionId: FString
DestinationApiName: FString
RejoinDialogResult: FOvrRejoinDialogResult &
ErrorMsg: FString &
Returns
void
GroupPresence_LaunchRosterPanel ( WorldContextObject , OutExecs , LatentInfo , Options , ErrorMsg )
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.
Signature
static void UOvrRequestsBlueprintLibrary::GroupPresence_LaunchRosterPanel(UObject *WorldContextObject, EOvrRequestOutputPins &OutExecs, FLatentActionInfo LatentInfo, FOvrRosterOptions Options, FString &ErrorMsg)
Parameters
WorldContextObject: UObject *
LatentInfo: FLatentActionInfo
ErrorMsg: FString &
Returns
void
GroupPresence_SendInvites ( WorldContextObject , OutExecs , LatentInfo , UserIDs , SendInvitesResult , ErrorMsg )
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.
Signature
static void UOvrRequestsBlueprintLibrary::GroupPresence_SendInvites(UObject *WorldContextObject, EOvrRequestOutputPins &OutExecs, FLatentActionInfo LatentInfo, TArray< FOvrId > UserIDs, FOvrSendInvitesResult &SendInvitesResult, FString &ErrorMsg)
Parameters
WorldContextObject: UObject *
LatentInfo: FLatentActionInfo
UserIDs: TArray< FOvrId >
SendInvitesResult: FOvrSendInvitesResult &
ErrorMsg: FString &
Returns
void
GroupPresence_Set ( WorldContextObject , OutExecs , LatentInfo , GroupPresenceOptions , ErrorMsg )
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.
Signature
static void UOvrRequestsBlueprintLibrary::GroupPresence_Set(UObject *WorldContextObject, EOvrRequestOutputPins &OutExecs, FLatentActionInfo LatentInfo, FOvrGroupPresenceOptions GroupPresenceOptions, FString &ErrorMsg)
Parameters
WorldContextObject: UObject *
LatentInfo: FLatentActionInfo
GroupPresenceOptions: FOvrGroupPresenceOptions
ErrorMsg: FString &
Returns
void
GroupPresence_SetDeeplinkMessageOverride ( WorldContextObject , OutExecs , LatentInfo , DeeplinkMessage , ErrorMsg )
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().
Signature
static void UOvrRequestsBlueprintLibrary::GroupPresence_SetDeeplinkMessageOverride(UObject *WorldContextObject, EOvrRequestOutputPins &OutExecs, FLatentActionInfo LatentInfo, FString DeeplinkMessage, FString &ErrorMsg)
Parameters
WorldContextObject: UObject *
LatentInfo: FLatentActionInfo
DeeplinkMessage: FString
ErrorMsg: FString &
Returns
void
GroupPresence_SetDestination ( WorldContextObject , OutExecs , LatentInfo , ApiName , ErrorMsg )
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.
Signature
static void UOvrRequestsBlueprintLibrary::GroupPresence_SetDestination(UObject *WorldContextObject, EOvrRequestOutputPins &OutExecs, FLatentActionInfo LatentInfo, FString ApiName, FString &ErrorMsg)
Parameters
WorldContextObject: UObject *
LatentInfo: FLatentActionInfo
ApiName: FString
ErrorMsg: FString &
Returns
void
GroupPresence_SetIsJoinable ( WorldContextObject , OutExecs , LatentInfo , IsJoinable , ErrorMsg )
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.
Signature
static void UOvrRequestsBlueprintLibrary::GroupPresence_SetIsJoinable(UObject *WorldContextObject, EOvrRequestOutputPins &OutExecs, FLatentActionInfo LatentInfo, bool IsJoinable, FString &ErrorMsg)
Parameters
WorldContextObject: UObject *
LatentInfo: FLatentActionInfo
IsJoinable: bool
ErrorMsg: FString &
Returns
void
GroupPresence_SetLobbySession ( WorldContextObject , OutExecs , LatentInfo , Id , ErrorMsg )
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.
Signature
static void UOvrRequestsBlueprintLibrary::GroupPresence_SetLobbySession(UObject *WorldContextObject, EOvrRequestOutputPins &OutExecs, FLatentActionInfo LatentInfo, FString Id, FString &ErrorMsg)
Parameters
WorldContextObject: UObject *
LatentInfo: FLatentActionInfo
Id: FString
ErrorMsg: FString &
Returns
void
GroupPresence_SetMatchSession ( WorldContextObject , OutExecs , LatentInfo , Id , ErrorMsg )
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().
Signature
static void UOvrRequestsBlueprintLibrary::GroupPresence_SetMatchSession(UObject *WorldContextObject, EOvrRequestOutputPins &OutExecs, FLatentActionInfo LatentInfo, FString Id, FString &ErrorMsg)
Parameters
WorldContextObject: UObject *
LatentInfo: FLatentActionInfo
Id: FString
ErrorMsg: FString &
Returns
void
IAP_ConsumePurchase ( WorldContextObject , OutExecs , LatentInfo , Sku , ErrorMsg )
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.
Signature
static void UOvrRequestsBlueprintLibrary::IAP_ConsumePurchase(UObject *WorldContextObject, EOvrRequestOutputPins &OutExecs, FLatentActionInfo LatentInfo, FString Sku, FString &ErrorMsg)
Parameters
WorldContextObject: UObject *
LatentInfo: FLatentActionInfo
Sku: FString
ErrorMsg: FString &
Returns
void
IAP_GetProductsBySKU ( WorldContextObject , OutExecs , LatentInfo , Skus , ProductPages , ErrorMsg )
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.
Signature
static void UOvrRequestsBlueprintLibrary::IAP_GetProductsBySKU(UObject *WorldContextObject, EOvrRequestOutputPins &OutExecs, FLatentActionInfo LatentInfo, TArray< FString > Skus, FOvrProductPages &ProductPages, FString &ErrorMsg)
Parameters
WorldContextObject: UObject *
LatentInfo: FLatentActionInfo
Skus: TArray< FString >
ProductPages: FOvrProductPages &
ErrorMsg: FString &
Returns
void
IAP_GetViewerPurchases ( WorldContextObject , OutExecs , LatentInfo , PurchasePages , ErrorMsg )
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.
Signature
static void UOvrRequestsBlueprintLibrary::IAP_GetViewerPurchases(UObject *WorldContextObject, EOvrRequestOutputPins &OutExecs, FLatentActionInfo LatentInfo, FOvrPurchasePages &PurchasePages, FString &ErrorMsg)
Parameters
WorldContextObject: UObject *
LatentInfo: FLatentActionInfo
PurchasePages: FOvrPurchasePages &
ErrorMsg: FString &
Returns
void
IAP_GetViewerPurchasesDurableCache ( WorldContextObject , OutExecs , LatentInfo , PurchasePages , ErrorMsg )
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.
Signature
static void UOvrRequestsBlueprintLibrary::IAP_GetViewerPurchasesDurableCache(UObject *WorldContextObject, EOvrRequestOutputPins &OutExecs, FLatentActionInfo LatentInfo, FOvrPurchasePages &PurchasePages, FString &ErrorMsg)
Parameters
WorldContextObject: UObject *
LatentInfo: FLatentActionInfo
PurchasePages: FOvrPurchasePages &
ErrorMsg: FString &
Returns
void
IAP_LaunchCheckoutFlow ( WorldContextObject , OutExecs , LatentInfo , Sku , Purchase , ErrorMsg )
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".
Signature
static void UOvrRequestsBlueprintLibrary::IAP_LaunchCheckoutFlow(UObject *WorldContextObject, EOvrRequestOutputPins &OutExecs, FLatentActionInfo LatentInfo, FString Sku, FOvrPurchase &Purchase, FString &ErrorMsg)
Parameters
WorldContextObject: UObject *
LatentInfo: FLatentActionInfo
Sku: FString
Purchase: FOvrPurchase &
ErrorMsg: FString &
Returns
void
LanguagePack_GetCurrent ( WorldContextObject , OutExecs , LatentInfo , AssetDetails , ErrorMsg )
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.
Signature
static void UOvrRequestsBlueprintLibrary::LanguagePack_GetCurrent(UObject *WorldContextObject, EOvrRequestOutputPins &OutExecs, FLatentActionInfo LatentInfo, FOvrAssetDetails &AssetDetails, FString &ErrorMsg)
Parameters
WorldContextObject: UObject *
LatentInfo: FLatentActionInfo
AssetDetails: FOvrAssetDetails &
ErrorMsg: FString &
Returns
void
LanguagePack_SetCurrent ( WorldContextObject , OutExecs , LatentInfo , Tag , AssetFileDownloadResult , ErrorMsg )
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.
Signature
static void UOvrRequestsBlueprintLibrary::LanguagePack_SetCurrent(UObject *WorldContextObject, EOvrRequestOutputPins &OutExecs, FLatentActionInfo LatentInfo, FString Tag, FOvrAssetFileDownloadResult &AssetFileDownloadResult, FString &ErrorMsg)
Parameters
WorldContextObject: UObject *
LatentInfo: FLatentActionInfo
Tag: FString
AssetFileDownloadResult: FOvrAssetFileDownloadResult &
ErrorMsg: FString &
Returns
void
Leaderboard_Get ( WorldContextObject , OutExecs , LatentInfo , LeaderboardName , LeaderboardPages , ErrorMsg )
Retrieves detailed information for a single leaderboard with a specified name, returning an array of FOvrLeaderboard.
Signature
static void UOvrRequestsBlueprintLibrary::Leaderboard_Get(UObject *WorldContextObject, EOvrRequestOutputPins &OutExecs, FLatentActionInfo LatentInfo, FString LeaderboardName, FOvrLeaderboardPages &LeaderboardPages, FString &ErrorMsg)
Parameters
WorldContextObject: UObject *
LatentInfo: FLatentActionInfo
LeaderboardName: FString
LeaderboardPages: FOvrLeaderboardPages &
ErrorMsg: FString &
Returns
void
Leaderboard_GetEntries ( WorldContextObject , OutExecs , LatentInfo , LeaderboardName , Limit , Filter , StartAt , LeaderboardEntryPages , ErrorMsg )
Retrieves a list of leaderboard entries for a specified LeaderboardName, with options to filter and limit the number of results returned.
Signature
static void UOvrRequestsBlueprintLibrary::Leaderboard_GetEntries(UObject *WorldContextObject, EOvrRequestOutputPins &OutExecs, FLatentActionInfo LatentInfo, FString LeaderboardName, int32 Limit, EOvrLeaderboardFilterType Filter, EOvrLeaderboardStartAt StartAt, FOvrLeaderboardEntryPages &LeaderboardEntryPages, FString &ErrorMsg)
Parameters
WorldContextObject: UObject *
LatentInfo: FLatentActionInfo
LeaderboardName: FString
Limit: int32
LeaderboardEntryPages: FOvrLeaderboardEntryPages &
ErrorMsg: FString &
Returns
void
Leaderboard_GetEntriesAfterRank ( WorldContextObject , OutExecs , LatentInfo , LeaderboardName , Limit , AfterRank , LeaderboardEntryPages , ErrorMsg )
Retrieves a block of leaderboard entries starting from a specific rank.
Signature
static void UOvrRequestsBlueprintLibrary::Leaderboard_GetEntriesAfterRank(UObject *WorldContextObject, EOvrRequestOutputPins &OutExecs, FLatentActionInfo LatentInfo, FString LeaderboardName, int32 Limit, int64 AfterRank, FOvrLeaderboardEntryPages &LeaderboardEntryPages, FString &ErrorMsg)
Parameters
WorldContextObject: UObject *
LatentInfo: FLatentActionInfo
LeaderboardName: FString
Limit: int32
AfterRank: int64
LeaderboardEntryPages: FOvrLeaderboardEntryPages &
ErrorMsg: FString &
Returns
void
Leaderboard_GetEntriesByIds ( WorldContextObject , OutExecs , LatentInfo , LeaderboardName , Limit , StartAt , UserIDs , LeaderboardEntryPages , ErrorMsg )
Retrieves a block of leaderboard entries that match the specified user IDs. Only entries corresponding to the provided user IDs will be returned.
Signature
static void UOvrRequestsBlueprintLibrary::Leaderboard_GetEntriesByIds(UObject *WorldContextObject, EOvrRequestOutputPins &OutExecs, FLatentActionInfo LatentInfo, FString LeaderboardName, int32 Limit, EOvrLeaderboardStartAt StartAt, TArray< FOvrId > UserIDs, FOvrLeaderboardEntryPages &LeaderboardEntryPages, FString &ErrorMsg)
Parameters
WorldContextObject: UObject *
LatentInfo: FLatentActionInfo
LeaderboardName: FString
Limit: int32
UserIDs: TArray< FOvrId >
LeaderboardEntryPages: FOvrLeaderboardEntryPages &
ErrorMsg: FString &
Returns
void
Leaderboard_WriteEntry ( WorldContextObject , OutExecs , LatentInfo , LeaderboardName , Score , ExtraData , ForceUpdate , LeaderboardUpdateStatus , ErrorMsg )
Writes a single entry to the leaderboard, returning FOvrLeaderboardUpdateStatus indicating whether the update was successful and providing the updated challenge IDs.
Signature
static void UOvrRequestsBlueprintLibrary::Leaderboard_WriteEntry(UObject *WorldContextObject, EOvrRequestOutputPins &OutExecs, FLatentActionInfo LatentInfo, FString LeaderboardName, int64 Score, TArray< uint8 > ExtraData, bool ForceUpdate, FOvrLeaderboardUpdateStatus &LeaderboardUpdateStatus, FString &ErrorMsg)
Parameters
WorldContextObject: UObject *
LatentInfo: FLatentActionInfo
LeaderboardName: FString
Score: int64
ExtraData: TArray< uint8 >
ForceUpdate: bool
LeaderboardUpdateStatus: FOvrLeaderboardUpdateStatus &
ErrorMsg: FString &
Returns
void
Leaderboard_WriteEntryWithSupplementaryMetric ( WorldContextObject , OutExecs , LatentInfo , LeaderboardName , Score , SupplementaryMetric , ExtraData , ForceUpdate , LeaderboardUpdateStatus , ErrorMsg )
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.
Signature
static void UOvrRequestsBlueprintLibrary::Leaderboard_WriteEntryWithSupplementaryMetric(UObject *WorldContextObject, EOvrRequestOutputPins &OutExecs, FLatentActionInfo LatentInfo, FString LeaderboardName, int64 Score, int64 SupplementaryMetric, TArray< uint8 > ExtraData, bool ForceUpdate, FOvrLeaderboardUpdateStatus &LeaderboardUpdateStatus, FString &ErrorMsg)
Parameters
WorldContextObject: UObject *
LatentInfo: FLatentActionInfo
LeaderboardName: FString
Score: int64
SupplementaryMetric: int64
ExtraData: TArray< uint8 >
ForceUpdate: bool
LeaderboardUpdateStatus: FOvrLeaderboardUpdateStatus &
ErrorMsg: FString &
Returns
void
Media_ShareToFacebook ( WorldContextObject , OutExecs , LatentInfo , PostTextSuggestion , FilePath , ContentType , ShareMediaResult , ErrorMsg )
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.
Signature
static void UOvrRequestsBlueprintLibrary::Media_ShareToFacebook(UObject *WorldContextObject, EOvrRequestOutputPins &OutExecs, FLatentActionInfo LatentInfo, FString PostTextSuggestion, FString FilePath, EOvrMediaContentType ContentType, FOvrShareMediaResult &ShareMediaResult, FString &ErrorMsg)
Parameters
WorldContextObject: UObject *
LatentInfo: FLatentActionInfo
PostTextSuggestion: FString
FilePath: FString
ShareMediaResult: FOvrShareMediaResult &
ErrorMsg: FString &
Returns
void
Notification_MarkAsRead ( WorldContextObject , OutExecs , LatentInfo , NotificationID , ErrorMsg )
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.
Signature
static void UOvrRequestsBlueprintLibrary::Notification_MarkAsRead(UObject *WorldContextObject, EOvrRequestOutputPins &OutExecs, FLatentActionInfo LatentInfo, FOvrId NotificationID, FString &ErrorMsg)
Parameters
WorldContextObject: UObject *
LatentInfo: FLatentActionInfo
NotificationID: FOvrId
ErrorMsg: FString &
Returns
void
PushNotification_Register ( WorldContextObject , OutExecs , LatentInfo , PushNotificationResult , ErrorMsg )
Register the device to receive push notification. The registered notification id can be fetched by field FOvrPushNotificationResult::Id.
Signature
static void UOvrRequestsBlueprintLibrary::PushNotification_Register(UObject *WorldContextObject, EOvrRequestOutputPins &OutExecs, FLatentActionInfo LatentInfo, FOvrPushNotificationResult &PushNotificationResult, FString &ErrorMsg)
Parameters
WorldContextObject: UObject *
LatentInfo: FLatentActionInfo
PushNotificationResult: FOvrPushNotificationResult &
ErrorMsg: FString &
Returns
void
RichPresence_GetDestinations ( WorldContextObject , OutExecs , LatentInfo , DestinationPages , ErrorMsg )
Gets all the FOvrDestination that the presence can be set to
Signature
static void UOvrRequestsBlueprintLibrary::RichPresence_GetDestinations(UObject *WorldContextObject, EOvrRequestOutputPins &OutExecs, FLatentActionInfo LatentInfo, FOvrDestinationPages &DestinationPages, FString &ErrorMsg)
Parameters
WorldContextObject: UObject *
LatentInfo: FLatentActionInfo
DestinationPages: FOvrDestinationPages &
ErrorMsg: FString &
Returns
void
User_Get ( WorldContextObject , OutExecs , LatentInfo , UserID , User , ErrorMsg )
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 void UOvrRequestsBlueprintLibrary::User_Get(UObject *WorldContextObject, EOvrRequestOutputPins &OutExecs, FLatentActionInfo LatentInfo, FOvrId UserID, FOvrUser &User, FString &ErrorMsg)
Parameters
WorldContextObject: UObject *
LatentInfo: FLatentActionInfo
UserID: FOvrId
User: FOvrUser &
ErrorMsg: FString &
Returns
void
User_GetAccessToken ( WorldContextObject , OutExecs , LatentInfo , StringPayload , ErrorMsg )
Return an access token string for this user, suitable for making REST calls against graph.oculus.com.
Signature
static void UOvrRequestsBlueprintLibrary::User_GetAccessToken(UObject *WorldContextObject, EOvrRequestOutputPins &OutExecs, FLatentActionInfo LatentInfo, FString &StringPayload, FString &ErrorMsg)
Parameters
WorldContextObject: UObject *
LatentInfo: FLatentActionInfo
StringPayload: FString &
ErrorMsg: FString &
Returns
void
User_GetBlockedUsers ( WorldContextObject , OutExecs , LatentInfo , BlockedUserPages , ErrorMsg )
Return the IDs of users entitled to use the current app that are blocked by the specified user
Signature
static void UOvrRequestsBlueprintLibrary::User_GetBlockedUsers(UObject *WorldContextObject, EOvrRequestOutputPins &OutExecs, FLatentActionInfo LatentInfo, FOvrBlockedUserPages &BlockedUserPages, FString &ErrorMsg)
Parameters
WorldContextObject: UObject *
LatentInfo: FLatentActionInfo
BlockedUserPages: FOvrBlockedUserPages &
ErrorMsg: FString &
Returns
void
User_GetLinkedAccounts ( WorldContextObject , OutExecs , LatentInfo , UserOptions , LinkedAccountArray , ErrorMsg )
Returns a list of linked accounts that are associated with the specified service providers.
Customization can be done via UserOptions. Create this object with FOvrUserOptions. The params that could be used are:
  1. FOvrUserOptions::ServiceProviders.Emplace() - returns the list of linked accounts that are associated with these specified service providers.
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); 
Signature
static void UOvrRequestsBlueprintLibrary::User_GetLinkedAccounts(UObject *WorldContextObject, EOvrRequestOutputPins &OutExecs, FLatentActionInfo LatentInfo, FOvrUserOptions UserOptions, TArray< FOvrLinkedAccount > &LinkedAccountArray, FString &ErrorMsg)
Parameters
WorldContextObject: UObject *
LatentInfo: FLatentActionInfo
UserOptions: FOvrUserOptions
LinkedAccountArray: TArray< FOvrLinkedAccount > &
ErrorMsg: FString &
Returns
void
User_GetLoggedInUser ( WorldContextObject , OutExecs , LatentInfo , User , ErrorMsg )
Retrieve the currently signed in user. This call is available offline.
NOTE: Please be aware that this function will only return the following information about the user: Alias (Oculus ID), ID (App Scoped ID), Profile URL (image_url). If you need to retrieve additional user information, such as presence details, please use the App Scoped ID obtained from Users.GetLoggedInUser() in conjunction with Users.Get(ulong UserID). This will provide access to more comprehensive user data.
NOTE: Users will have a unique ID per application.
Signature
static void UOvrRequestsBlueprintLibrary::User_GetLoggedInUser(UObject *WorldContextObject, EOvrRequestOutputPins &OutExecs, FLatentActionInfo LatentInfo, FOvrUser &User, FString &ErrorMsg)
Parameters
WorldContextObject: UObject *
LatentInfo: FLatentActionInfo
User: FOvrUser &
ErrorMsg: FString &
Returns
void
User_GetLoggedInUserFriends ( WorldContextObject , OutExecs , LatentInfo , UserPages , ErrorMsg )
Retrieve a list of the logged in user's bidirectional followers. The payload type will be an array of FOvrUser
Signature
static void UOvrRequestsBlueprintLibrary::User_GetLoggedInUserFriends(UObject *WorldContextObject, EOvrRequestOutputPins &OutExecs, FLatentActionInfo LatentInfo, FOvrUserPages &UserPages, FString &ErrorMsg)
Parameters
WorldContextObject: UObject *
LatentInfo: FLatentActionInfo
UserPages: FOvrUserPages &
ErrorMsg: FString &
Returns
void
User_GetLoggedInUserManagedInfo ( WorldContextObject , OutExecs , LatentInfo , User , ErrorMsg )
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).
Signature
static void UOvrRequestsBlueprintLibrary::User_GetLoggedInUserManagedInfo(UObject *WorldContextObject, EOvrRequestOutputPins &OutExecs, FLatentActionInfo LatentInfo, FOvrUser &User, FString &ErrorMsg)
Parameters
WorldContextObject: UObject *
LatentInfo: FLatentActionInfo
User: FOvrUser &
ErrorMsg: FString &
Returns
void
User_GetOrgScopedID ( WorldContextObject , OutExecs , LatentInfo , UserID , OrgScopedID , ErrorMsg )
returns an ovrID which is unique per org. allows different apps within the same org to identify the user.
Signature
static void UOvrRequestsBlueprintLibrary::User_GetOrgScopedID(UObject *WorldContextObject, EOvrRequestOutputPins &OutExecs, FLatentActionInfo LatentInfo, FOvrId UserID, FOvrOrgScopedID &OrgScopedID, FString &ErrorMsg)
Parameters
WorldContextObject: UObject *
LatentInfo: FLatentActionInfo
UserID: FOvrId
OrgScopedID: FOvrOrgScopedID &
ErrorMsg: FString &
Returns
void
User_GetSdkAccounts ( WorldContextObject , OutExecs , LatentInfo , SdkAccountArray , ErrorMsg )
Returns all accounts belonging to this user. Accounts are the Oculus user and x-users that are linked to this user.
Signature
static void UOvrRequestsBlueprintLibrary::User_GetSdkAccounts(UObject *WorldContextObject, EOvrRequestOutputPins &OutExecs, FLatentActionInfo LatentInfo, TArray< FOvrSdkAccount > &SdkAccountArray, FString &ErrorMsg)
Parameters
WorldContextObject: UObject *
LatentInfo: FLatentActionInfo
SdkAccountArray: TArray< FOvrSdkAccount > &
ErrorMsg: FString &
Returns
void
User_GetUserProof ( WorldContextObject , OutExecs , LatentInfo , UserProof , ErrorMsg )
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.
Signature
static void UOvrRequestsBlueprintLibrary::User_GetUserProof(UObject *WorldContextObject, EOvrRequestOutputPins &OutExecs, FLatentActionInfo LatentInfo, FOvrUserProof &UserProof, FString &ErrorMsg)
Parameters
WorldContextObject: UObject *
LatentInfo: FLatentActionInfo
UserProof: FOvrUserProof &
ErrorMsg: FString &
Returns
void
User_LaunchBlockFlow ( WorldContextObject , OutExecs , LatentInfo , UserID , LaunchBlockFlowResult , ErrorMsg )
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 void UOvrRequestsBlueprintLibrary::User_LaunchBlockFlow(UObject *WorldContextObject, EOvrRequestOutputPins &OutExecs, FLatentActionInfo LatentInfo, FOvrId UserID, FOvrLaunchBlockFlowResult &LaunchBlockFlowResult, FString &ErrorMsg)
Parameters
WorldContextObject: UObject *
LatentInfo: FLatentActionInfo
UserID: FOvrId
LaunchBlockFlowResult: FOvrLaunchBlockFlowResult &
ErrorMsg: FString &
Returns
void
User_LaunchFriendRequestFlow ( WorldContextObject , OutExecs , LatentInfo , UserID , LaunchFriendRequestFlowResult , ErrorMsg )
Launch the flow for sending a follow request to a user.
Signature
static void UOvrRequestsBlueprintLibrary::User_LaunchFriendRequestFlow(UObject *WorldContextObject, EOvrRequestOutputPins &OutExecs, FLatentActionInfo LatentInfo, FOvrId UserID, FOvrLaunchFriendRequestFlowResult &LaunchFriendRequestFlowResult, FString &ErrorMsg)
Parameters
WorldContextObject: UObject *
LatentInfo: FLatentActionInfo
UserID: FOvrId
LaunchFriendRequestFlowResult: FOvrLaunchFriendRequestFlowResult &
ErrorMsg: FString &
Returns
void
User_LaunchUnblockFlow ( WorldContextObject , OutExecs , LatentInfo , UserID , LaunchUnblockFlowResult , ErrorMsg )
Launch the flow for unblocking a user that the viewer has blocked.
Signature
static void UOvrRequestsBlueprintLibrary::User_LaunchUnblockFlow(UObject *WorldContextObject, EOvrRequestOutputPins &OutExecs, FLatentActionInfo LatentInfo, FOvrId UserID, FOvrLaunchUnblockFlowResult &LaunchUnblockFlowResult, FString &ErrorMsg)
Parameters
WorldContextObject: UObject *
LatentInfo: FLatentActionInfo
UserID: FOvrId
LaunchUnblockFlowResult: FOvrLaunchUnblockFlowResult &
ErrorMsg: FString &
Returns
void
UserAgeCategory_Get ( WorldContextObject , OutExecs , LatentInfo , UserAccountAgeCategory , ErrorMsg )
Retrieve the user age category for the current user. It can be used in field FOvrUserAccountAgeCategory::AgeCategory
Signature
static void UOvrRequestsBlueprintLibrary::UserAgeCategory_Get(UObject *WorldContextObject, EOvrRequestOutputPins &OutExecs, FLatentActionInfo LatentInfo, FOvrUserAccountAgeCategory &UserAccountAgeCategory, FString &ErrorMsg)
Parameters
WorldContextObject: UObject *
LatentInfo: FLatentActionInfo
UserAccountAgeCategory: FOvrUserAccountAgeCategory &
ErrorMsg: FString &
Returns
void
UserAgeCategory_Report ( WorldContextObject , OutExecs , LatentInfo , AgeCategory , ErrorMsg )
Report the current user's age category to Meta.
Signature
static void UOvrRequestsBlueprintLibrary::UserAgeCategory_Report(UObject *WorldContextObject, EOvrRequestOutputPins &OutExecs, FLatentActionInfo LatentInfo, EOvrAppAgeCategory AgeCategory, FString &ErrorMsg)
Parameters
WorldContextObject: UObject *
LatentInfo: FLatentActionInfo
AgeCategory: EOvrAppAgeCategory
ErrorMsg: FString &
Returns
void
Voip_GetMicrophoneAvailability ( WorldContextObject , OutExecs , LatentInfo , MicrophoneAvailabilityState , ErrorMsg )
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.
Signature
static void UOvrRequestsBlueprintLibrary::Voip_GetMicrophoneAvailability(UObject *WorldContextObject, EOvrRequestOutputPins &OutExecs, FLatentActionInfo LatentInfo, FOvrMicrophoneAvailabilityState &MicrophoneAvailabilityState, FString &ErrorMsg)
Parameters
WorldContextObject: UObject *
LatentInfo: FLatentActionInfo
MicrophoneAvailabilityState: FOvrMicrophoneAvailabilityState &
ErrorMsg: FString &
Returns
void
Voip_SetSystemVoipSuppressed ( WorldContextObject , OutExecs , LatentInfo , Suppressed , SystemVoipState , ErrorMsg )
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.
Signature
static void UOvrRequestsBlueprintLibrary::Voip_SetSystemVoipSuppressed(UObject *WorldContextObject, EOvrRequestOutputPins &OutExecs, FLatentActionInfo LatentInfo, bool Suppressed, FOvrSystemVoipState &SystemVoipState, FString &ErrorMsg)
Parameters
WorldContextObject: UObject *
LatentInfo: FLatentActionInfo
Suppressed: bool
SystemVoipState: FOvrSystemVoipState &
ErrorMsg: FString &
Returns
void