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

UOvrRequestsBlueprintLibrary Class

UOvrRequestsBlueprintLibrary extends UBlueprintFunctionLibrary.

Overview

Static Public Member Functions

static void
AbuseReport_ReportRequestHandled
( UObject * WorldContextObject,
FLatentActionInfo LatentInfo,
FString & ErrorMsg )
static void
Achievements_AddCount
( UObject * WorldContextObject,
FLatentActionInfo LatentInfo,
FString Name,
int64 Count,
FOvrAchievementUpdate & AchievementUpdate,
FString & ErrorMsg )
static void
Achievements_AddFields
( UObject * WorldContextObject,
FLatentActionInfo LatentInfo,
FString Name,
FString Fields,
FOvrAchievementUpdate & AchievementUpdate,
FString & ErrorMsg )
static void
Achievements_GetAllDefinitions
( UObject * WorldContextObject,
FLatentActionInfo LatentInfo,
FOvrAchievementDefinitionPages & AchievementDefinitionPages,
FString & ErrorMsg )
static void
Achievements_GetAllProgress
( UObject * WorldContextObject,
FLatentActionInfo LatentInfo,
FOvrAchievementProgressPages & AchievementProgressPages,
FString & ErrorMsg )
static void
Achievements_GetDefinitionsByName
( UObject * WorldContextObject,
FLatentActionInfo LatentInfo,
TArray< FString > Names,
FOvrAchievementDefinitionPages & AchievementDefinitionPages,
FString & ErrorMsg )
static void
Achievements_GetProgressByName
( UObject * WorldContextObject,
FLatentActionInfo LatentInfo,
TArray< FString > Names,
FOvrAchievementProgressPages & AchievementProgressPages,
FString & ErrorMsg )
static void
Achievements_Unlock
( UObject * WorldContextObject,
FLatentActionInfo LatentInfo,
FString Name,
FOvrAchievementUpdate & AchievementUpdate,
FString & ErrorMsg )
static void
Application_CancelAppDownload
( UObject * WorldContextObject,
FLatentActionInfo LatentInfo,
FOvrAppDownloadResult & AppDownloadResult,
FString & ErrorMsg )
static void
Application_CheckAppDownloadProgress
( UObject * WorldContextObject,
FLatentActionInfo LatentInfo,
FOvrAppDownloadProgressResult & AppDownloadProgressResult,
FString & ErrorMsg )
static void
Application_GetVersion
( UObject * WorldContextObject,
FLatentActionInfo LatentInfo,
FOvrApplicationVersion & ApplicationVersion,
FString & ErrorMsg )
static void
Application_InstallAppUpdateAndRelaunch
( UObject * WorldContextObject,
FLatentActionInfo LatentInfo,
FOvrApplicationOptions DeeplinkOptions,
FOvrAppDownloadResult & AppDownloadResult,
FString & ErrorMsg )
static void
Application_LaunchOtherApp
( UObject * WorldContextObject,
FLatentActionInfo LatentInfo,
FOvrId AppID,
FOvrApplicationOptions DeeplinkOptions,
FString & StringPayload,
FString & ErrorMsg )
static void
Application_StartAppDownload
( UObject * WorldContextObject,
FLatentActionInfo LatentInfo,
FOvrAppDownloadResult & AppDownloadResult,
FString & ErrorMsg )
static void
AssetFile_DeleteById
( UObject * WorldContextObject,
FLatentActionInfo LatentInfo,
FOvrId AssetFileID,
FOvrAssetFileDeleteResult & AssetFileDeleteResult,
FString & ErrorMsg )
static void
AssetFile_DeleteByName
( UObject * WorldContextObject,
FLatentActionInfo LatentInfo,
FString AssetFileName,
FOvrAssetFileDeleteResult & AssetFileDeleteResult,
FString & ErrorMsg )
static void
AssetFile_DownloadById
( UObject * WorldContextObject,
FLatentActionInfo LatentInfo,
FOvrId AssetFileID,
FOvrAssetFileDownloadResult & AssetFileDownloadResult,
FString & ErrorMsg )
static void
AssetFile_DownloadByName
( UObject * WorldContextObject,
FLatentActionInfo LatentInfo,
FString AssetFileName,
FOvrAssetFileDownloadResult & AssetFileDownloadResult,
FString & ErrorMsg )
static void
AssetFile_DownloadCancelById
( UObject * WorldContextObject,
FLatentActionInfo LatentInfo,
FOvrId AssetFileID,
FOvrAssetFileDownloadCancelResult & AssetFileDownloadCancelResult,
FString & ErrorMsg )
static void
AssetFile_DownloadCancelByName
( UObject * WorldContextObject,
FLatentActionInfo LatentInfo,
FString AssetFileName,
FOvrAssetFileDownloadCancelResult & AssetFileDownloadCancelResult,
FString & ErrorMsg )
static void
AssetFile_GetList
( UObject * WorldContextObject,
FLatentActionInfo LatentInfo,
TArray< FOvrAssetDetails > & AssetDetailsArray,
FString & ErrorMsg )
static void
AssetFile_StatusById
( UObject * WorldContextObject,
FLatentActionInfo LatentInfo,
FOvrId AssetFileID,
FOvrAssetDetails & AssetDetails,
FString & ErrorMsg )
static void
AssetFile_StatusByName
( UObject * WorldContextObject,
FLatentActionInfo LatentInfo,
FString AssetFileName,
FOvrAssetDetails & AssetDetails,
FString & ErrorMsg )
static void
Avatar_LaunchAvatarEditor
( UObject * WorldContextObject,
FLatentActionInfo LatentInfo,
FOvrAvatarEditorResult & AvatarEditorResult,
FString & ErrorMsg )
static void
Challenges_Create
( UObject * WorldContextObject,
FLatentActionInfo LatentInfo,
FString LeaderboardName,
FOvrChallengeOptions ChallengeOptions,
FOvrChallenge & Challenge,
FString & ErrorMsg )
static void
Challenges_DeclineInvite
( UObject * WorldContextObject,
FLatentActionInfo LatentInfo,
FOvrId ChallengeID,
FOvrChallenge & Challenge,
FString & ErrorMsg )
static void
Challenges_Delete
( UObject * WorldContextObject,
FLatentActionInfo LatentInfo,
FOvrId ChallengeID,
FString & ErrorMsg )
static void
Challenges_Get
( UObject * WorldContextObject,
FLatentActionInfo LatentInfo,
FOvrId ChallengeID,
FOvrChallenge & Challenge,
FString & ErrorMsg )
static void
Challenges_GetEntries
( UObject * WorldContextObject,
FLatentActionInfo LatentInfo,
FOvrId ChallengeID,
int32 Limit,
FOvrChallengeEntryPages & ChallengeEntryPages,
FString & ErrorMsg )
static void
Challenges_GetEntriesAfterRank
( UObject * WorldContextObject,
FLatentActionInfo LatentInfo,
FOvrId ChallengeID,
int32 Limit,
int64 AfterRank,
FOvrChallengeEntryPages & ChallengeEntryPages,
FString & ErrorMsg )
static void
Challenges_GetEntriesByIds
( UObject * WorldContextObject,
FLatentActionInfo LatentInfo,
FOvrId ChallengeID,
int32 Limit,
TArray< FOvrId > UserIDs,
FOvrChallengeEntryPages & ChallengeEntryPages,
FString & ErrorMsg )
static void
Challenges_GetList
( UObject * WorldContextObject,
FLatentActionInfo LatentInfo,
FOvrChallengeOptions ChallengeOptions,
int32 Limit,
FOvrChallengePages & ChallengePages,
FString & ErrorMsg )
static void
Challenges_Join
( UObject * WorldContextObject,
FLatentActionInfo LatentInfo,
FOvrId ChallengeID,
FOvrChallenge & Challenge,
FString & ErrorMsg )
static void
Challenges_Leave
( UObject * WorldContextObject,
FLatentActionInfo LatentInfo,
FOvrId ChallengeID,
FOvrChallenge & Challenge,
FString & ErrorMsg )
static void
Challenges_UpdateInfo
( UObject * WorldContextObject,
FLatentActionInfo LatentInfo,
FOvrId ChallengeID,
FOvrChallengeOptions ChallengeOptions,
FOvrChallenge & Challenge,
FString & ErrorMsg )
static void
Cowatching_GetPresenterData
( UObject * WorldContextObject,
FLatentActionInfo LatentInfo,
FString & StringPayload,
FString & ErrorMsg )
static void
Cowatching_GetViewersData
( UObject * WorldContextObject,
FLatentActionInfo LatentInfo,
FOvrCowatchViewerPages & CowatchViewerPages,
FString & ErrorMsg )
static void
Cowatching_IsInSession
( UObject * WorldContextObject,
FLatentActionInfo LatentInfo,
FOvrCowatchingState & CowatchingState,
FString & ErrorMsg )
static void
Cowatching_JoinSession
( UObject * WorldContextObject,
FLatentActionInfo LatentInfo,
FString & ErrorMsg )
static void
Cowatching_LaunchInviteDialog
( UObject * WorldContextObject,
FLatentActionInfo LatentInfo,
FString & ErrorMsg )
static void
Cowatching_LeaveSession
( UObject * WorldContextObject,
FLatentActionInfo LatentInfo,
FString & ErrorMsg )
static void
Cowatching_RequestToPresent
( UObject * WorldContextObject,
FLatentActionInfo LatentInfo,
FString & ErrorMsg )
static void
Cowatching_ResignFromPresenting
( UObject * WorldContextObject,
FLatentActionInfo LatentInfo,
FString & ErrorMsg )
static void
Cowatching_SetPresenterData
( UObject * WorldContextObject,
FLatentActionInfo LatentInfo,
FString VideoTitle,
FString PresenterData,
FString & ErrorMsg )
static void
Cowatching_SetViewerData
( UObject * WorldContextObject,
FLatentActionInfo LatentInfo,
FString ViewerData,
FString & ErrorMsg )
static void
DeviceApplicationIntegrity_GetIntegrityToken
( UObject * WorldContextObject,
FLatentActionInfo LatentInfo,
FString ChallengeNonce,
FString & StringPayload,
FString & ErrorMsg )
static void
Entitlement_GetIsViewerEntitled
( UObject * WorldContextObject,
FLatentActionInfo LatentInfo,
FString & ErrorMsg )
static void
GroupPresence_Clear
( UObject * WorldContextObject,
FLatentActionInfo LatentInfo,
FString & ErrorMsg )
static void
GroupPresence_GetInvitableUsers
( UObject * WorldContextObject,
FLatentActionInfo LatentInfo,
FOvrUserPages & UserPages,
FString & ErrorMsg )
static void
GroupPresence_GetSentInvites
( UObject * WorldContextObject,
FLatentActionInfo LatentInfo,
FOvrApplicationInvitePages & ApplicationInvitePages,
FString & ErrorMsg )
static void
GroupPresence_LaunchInvitePanel
( UObject * WorldContextObject,
FLatentActionInfo LatentInfo,
FOvrInvitePanelResultInfo & InvitePanelResultInfo,
FString & ErrorMsg )
static void
GroupPresence_LaunchMultiplayerErrorDialog
( UObject * WorldContextObject,
FLatentActionInfo LatentInfo,
FString & ErrorMsg )
static void
GroupPresence_LaunchRejoinDialog
( UObject * WorldContextObject,
FLatentActionInfo LatentInfo,
FString LobbySessionId,
FString MatchSessionId,
FString DestinationApiName,
FOvrRejoinDialogResult & RejoinDialogResult,
FString & ErrorMsg )
static void
GroupPresence_LaunchRosterPanel
( UObject * WorldContextObject,
FLatentActionInfo LatentInfo,
FString & ErrorMsg )
static void
GroupPresence_SendInvites
( UObject * WorldContextObject,
FLatentActionInfo LatentInfo,
TArray< FOvrId > UserIDs,
FOvrSendInvitesResult & SendInvitesResult,
FString & ErrorMsg )
static void
GroupPresence_Set
( UObject * WorldContextObject,
FLatentActionInfo LatentInfo,
FOvrGroupPresenceOptions GroupPresenceOptions,
FString & ErrorMsg )
static void
GroupPresence_SetDeeplinkMessageOverride
( UObject * WorldContextObject,
FLatentActionInfo LatentInfo,
FString DeeplinkMessage,
FString & ErrorMsg )
static void
GroupPresence_SetDestination
( UObject * WorldContextObject,
FLatentActionInfo LatentInfo,
FString ApiName,
FString & ErrorMsg )
static void
GroupPresence_SetIsJoinable
( UObject * WorldContextObject,
FLatentActionInfo LatentInfo,
bool IsJoinable,
FString & ErrorMsg )
static void
GroupPresence_SetLobbySession
( UObject * WorldContextObject,
FLatentActionInfo LatentInfo,
FString Id,
FString & ErrorMsg )
static void
GroupPresence_SetMatchSession
( UObject * WorldContextObject,
FLatentActionInfo LatentInfo,
FString Id,
FString & ErrorMsg )
static void
IAP_ConsumePurchase
( UObject * WorldContextObject,
FLatentActionInfo LatentInfo,
FString Sku,
FString & ErrorMsg )
static void
IAP_GetProductsBySKU
( UObject * WorldContextObject,
FLatentActionInfo LatentInfo,
TArray< FString > Skus,
FOvrProductPages & ProductPages,
FString & ErrorMsg )
static void
IAP_GetViewerPurchases
( UObject * WorldContextObject,
FLatentActionInfo LatentInfo,
FOvrPurchasePages & PurchasePages,
FString & ErrorMsg )
static void
IAP_GetViewerPurchasesDurableCache
( UObject * WorldContextObject,
FLatentActionInfo LatentInfo,
FOvrPurchasePages & PurchasePages,
FString & ErrorMsg )
static void
IAP_LaunchCheckoutFlow
( UObject * WorldContextObject,
FLatentActionInfo LatentInfo,
FString Sku,
FOvrPurchase & Purchase,
FString & ErrorMsg )
static void
LanguagePack_GetCurrent
( UObject * WorldContextObject,
FLatentActionInfo LatentInfo,
FOvrAssetDetails & AssetDetails,
FString & ErrorMsg )
static void
LanguagePack_SetCurrent
( UObject * WorldContextObject,
FLatentActionInfo LatentInfo,
FString Tag,
FOvrAssetFileDownloadResult & AssetFileDownloadResult,
FString & ErrorMsg )
static void
Leaderboard_Get
( UObject * WorldContextObject,
FLatentActionInfo LatentInfo,
FString LeaderboardName,
FOvrLeaderboardPages & LeaderboardPages,
FString & ErrorMsg )
static void
Leaderboard_GetEntries
( UObject * WorldContextObject,
FLatentActionInfo LatentInfo,
FString LeaderboardName,
int32 Limit,
FOvrLeaderboardEntryPages & LeaderboardEntryPages,
FString & ErrorMsg )
static void
Leaderboard_GetEntriesAfterRank
( UObject * WorldContextObject,
FLatentActionInfo LatentInfo,
FString LeaderboardName,
int32 Limit,
int64 AfterRank,
FOvrLeaderboardEntryPages & LeaderboardEntryPages,
FString & ErrorMsg )
static void
Leaderboard_GetEntriesByIds
( UObject * WorldContextObject,
FLatentActionInfo LatentInfo,
FString LeaderboardName,
int32 Limit,
TArray< FOvrId > UserIDs,
FOvrLeaderboardEntryPages & LeaderboardEntryPages,
FString & ErrorMsg )
static void
Leaderboard_WriteEntry
( UObject * WorldContextObject,
FLatentActionInfo LatentInfo,
FString LeaderboardName,
int64 Score,
TArray< uint8 > ExtraData,
bool ForceUpdate,
FOvrLeaderboardUpdateStatus & LeaderboardUpdateStatus,
FString & ErrorMsg )
static void
Leaderboard_WriteEntryWithSupplementaryMetric
( UObject * WorldContextObject,
FLatentActionInfo LatentInfo,
FString LeaderboardName,
int64 Score,
int64 SupplementaryMetric,
TArray< uint8 > ExtraData,
bool ForceUpdate,
FOvrLeaderboardUpdateStatus & LeaderboardUpdateStatus,
FString & ErrorMsg )
static void
Media_ShareToFacebook
( UObject * WorldContextObject,
FLatentActionInfo LatentInfo,
FString PostTextSuggestion,
FString FilePath,
EOvrMediaContentType ContentType,
FOvrShareMediaResult & ShareMediaResult,
FString & ErrorMsg )
static void
Notification_MarkAsRead
( UObject * WorldContextObject,
FLatentActionInfo LatentInfo,
FOvrId NotificationID,
FString & ErrorMsg )
static void
Party_GetCurrent
( UObject * WorldContextObject,
FLatentActionInfo LatentInfo,
FOvrParty & Party,
FString & ErrorMsg )
static void
RichPresence_Clear
( UObject * WorldContextObject,
FLatentActionInfo LatentInfo,
FString & ErrorMsg )
static void
RichPresence_GetDestinations
( UObject * WorldContextObject,
FLatentActionInfo LatentInfo,
FOvrDestinationPages & DestinationPages,
FString & ErrorMsg )
static void
User_Get
( UObject * WorldContextObject,
FLatentActionInfo LatentInfo,
FOvrId UserID,
FOvrUser & User,
FString & ErrorMsg )
static void
User_GetAccessToken
( UObject * WorldContextObject,
FLatentActionInfo LatentInfo,
FString & StringPayload,
FString & ErrorMsg )
static void
User_GetBlockedUsers
( UObject * WorldContextObject,
FLatentActionInfo LatentInfo,
FOvrBlockedUserPages & BlockedUserPages,
FString & ErrorMsg )
static void
User_GetLoggedInUser
( UObject * WorldContextObject,
FLatentActionInfo LatentInfo,
FOvrUser & User,
FString & ErrorMsg )
static void
User_GetLoggedInUserFriends
( UObject * WorldContextObject,
FLatentActionInfo LatentInfo,
FOvrUserPages & UserPages,
FString & ErrorMsg )
static void
User_GetOrgScopedID
( UObject * WorldContextObject,
FLatentActionInfo LatentInfo,
FOvrId UserID,
FOvrOrgScopedID & OrgScopedID,
FString & ErrorMsg )
static void
User_GetSdkAccounts
( UObject * WorldContextObject,
FLatentActionInfo LatentInfo,
TArray< FOvrSdkAccount > & SdkAccountArray,
FString & ErrorMsg )
static void
User_GetUserProof
( UObject * WorldContextObject,
FLatentActionInfo LatentInfo,
FOvrUserProof & UserProof,
FString & ErrorMsg )
static void
User_LaunchBlockFlow
( UObject * WorldContextObject,
FLatentActionInfo LatentInfo,
FOvrId UserID,
FOvrLaunchBlockFlowResult & LaunchBlockFlowResult,
FString & ErrorMsg )
static void
User_LaunchFriendRequestFlow
( UObject * WorldContextObject,
FLatentActionInfo LatentInfo,
FOvrId UserID,
FOvrLaunchFriendRequestFlowResult & LaunchFriendRequestFlowResult,
FString & ErrorMsg )
static void
User_LaunchUnblockFlow
( UObject * WorldContextObject,
FLatentActionInfo LatentInfo,
FOvrId UserID,
FOvrLaunchUnblockFlowResult & LaunchUnblockFlowResult,
FString & ErrorMsg )
static void
UserAgeCategory_Get
( UObject * WorldContextObject,
FLatentActionInfo LatentInfo,
FOvrUserAccountAgeCategory & UserAccountAgeCategory,
FString & ErrorMsg )
static void
UserAgeCategory_Report
( UObject * WorldContextObject,
FLatentActionInfo LatentInfo,
EOvrAppAgeCategory AgeCategory,
FString & ErrorMsg )
static void
Voip_GetMicrophoneAvailability
( UObject * WorldContextObject,
FLatentActionInfo LatentInfo,
FOvrMicrophoneAvailabilityState & MicrophoneAvailabilityState,
FString & ErrorMsg )
static void
Voip_SetSystemVoipSuppressed
( UObject * WorldContextObject,
FLatentActionInfo LatentInfo,
bool Suppressed,
FOvrSystemVoipState & SystemVoipState,
FString & ErrorMsg )

Public Member Functions

UFUNCTION
( BlueprintCallable ,
meta ,
Category )
UFUNCTION
( BlueprintCallable ,
meta ,
Category )
UFUNCTION
( BlueprintCallable ,
meta ,
Category )
UFUNCTION
( BlueprintCallable ,
meta ,
Category )
UFUNCTION
( BlueprintCallable ,
meta ,
Category )

Details

Fields

EOvrRequestOutputPins & UOvrRequestsBlueprintLibrary::OutExecs
No description available.
EOvrRequestOutputPins FLatentActionInfo UOvrRequestsBlueprintLibrary::LatentInfo
No description available.
EOvrRequestOutputPins FLatentActionInfo FOvrId UOvrRequestsBlueprintLibrary::AssetFileID
No description available.
EOvrRequestOutputPins FLatentActionInfo FOvrId FOvrAssetFileDeleteResult& UOvrRequestsBlueprintLibrary::AssetFileDeleteResult
No description available.
EOvrRequestOutputPins FLatentActionInfo FOvrId FOvrAssetFileDeleteResult FString& UOvrRequestsBlueprintLibrary::ErrorMsg
No description available.
EOvrRequestOutputPins FLatentActionInfo FOvrId FOvrAssetFileDownloadResult& UOvrRequestsBlueprintLibrary::AssetFileDownloadResult
No description available.
EOvrRequestOutputPins FLatentActionInfo FOvrId FOvrAssetFileDownloadResult FString& UOvrRequestsBlueprintLibrary::ErrorMsg
No description available.
EOvrRequestOutputPins FLatentActionInfo FOvrId FOvrAssetFileDownloadCancelResult& UOvrRequestsBlueprintLibrary::AssetFileDownloadCancelResult
No description available.
EOvrRequestOutputPins FLatentActionInfo FOvrId FOvrAssetFileDownloadCancelResult FString& UOvrRequestsBlueprintLibrary::ErrorMsg
No description available.
EOvrRequestOutputPins FLatentActionInfo FOvrId FOvrAssetDetails& UOvrRequestsBlueprintLibrary::AssetDetails
No description available.
EOvrRequestOutputPins FLatentActionInfo FOvrId FOvrAssetDetails FString& UOvrRequestsBlueprintLibrary::ErrorMsg
No description available.
EOvrRequestOutputPins FLatentActionInfo FOvrRichPresenceOptions UOvrRequestsBlueprintLibrary::RichPresenceOptions
No description available.
EOvrRequestOutputPins FLatentActionInfo FOvrRichPresenceOptions FString& UOvrRequestsBlueprintLibrary::ErrorMsg
No description available.

Static Member Functions

static void UOvrRequestsBlueprintLibrary::AbuseReport_ReportRequestHandled
( UObject * WorldContextObject,
FLatentActionInfo LatentInfo,
FString & ErrorMsg )
The currently running application has indicated they want to show their in-app reporting flow or that they choose to ignore the request.
static void UOvrRequestsBlueprintLibrary::Achievements_AddCount
( UObject * WorldContextObject,
FLatentActionInfo LatentInfo,
FString Name,
int64 Count,
FOvrAchievementUpdate & AchievementUpdate,
FString & 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.
static void UOvrRequestsBlueprintLibrary::Achievements_AddFields
( UObject * WorldContextObject,
FLatentActionInfo LatentInfo,
FString Name,
FString Fields,
FOvrAchievementUpdate & AchievementUpdate,
FString & ErrorMsg )
Unlock fields of a BITFIELD achievement.
Parameters
Name
- The name of the achievement to unlock
Fields
- A string containing either '0' or '1' characters. Every '1' will unlock the field in the corresponding position.
static void UOvrRequestsBlueprintLibrary::Achievements_GetAllDefinitions
( UObject * WorldContextObject,
FLatentActionInfo LatentInfo,
FOvrAchievementDefinitionPages & AchievementDefinitionPages,
FString & ErrorMsg )
Request all achievement definitions for the app.
static void UOvrRequestsBlueprintLibrary::Achievements_GetAllProgress
( UObject * WorldContextObject,
FLatentActionInfo LatentInfo,
FOvrAchievementProgressPages & AchievementProgressPages,
FString & ErrorMsg )
Request the progress for the user on all achievements in the app.
static void UOvrRequestsBlueprintLibrary::Achievements_GetDefinitionsByName
( UObject * WorldContextObject,
FLatentActionInfo LatentInfo,
TArray< FString > Names,
FOvrAchievementDefinitionPages & AchievementDefinitionPages,
FString & ErrorMsg )
Request the achievement definitions that match the specified names.
static void UOvrRequestsBlueprintLibrary::Achievements_GetProgressByName
( UObject * WorldContextObject,
FLatentActionInfo LatentInfo,
TArray< FString > Names,
FOvrAchievementProgressPages & AchievementProgressPages,
FString & ErrorMsg )
Request the user's progress on the specified achievements.
static void UOvrRequestsBlueprintLibrary::Achievements_Unlock
( UObject * WorldContextObject,
FLatentActionInfo LatentInfo,
FString Name,
FOvrAchievementUpdate & AchievementUpdate,
FString & ErrorMsg )
Unlock the achievement with the given name. This can be of any achievement type.
static void UOvrRequestsBlueprintLibrary::Application_CancelAppDownload
( UObject * WorldContextObject,
FLatentActionInfo LatentInfo,
FOvrAppDownloadResult & AppDownloadResult,
FString & ErrorMsg )
Cancel an app download that is in progress. It will return a result when the download is cancelled.
static void UOvrRequestsBlueprintLibrary::Application_CheckAppDownloadProgress
( UObject * WorldContextObject,
FLatentActionInfo LatentInfo,
FOvrAppDownloadProgressResult & AppDownloadProgressResult,
FString & ErrorMsg )
Track download progress for an app
static void UOvrRequestsBlueprintLibrary::Application_GetVersion
( UObject * WorldContextObject,
FLatentActionInfo LatentInfo,
FOvrApplicationVersion & ApplicationVersion,
FString & ErrorMsg )
Requests version information, including the version code and version name of the currently installed app and version code, version name, size and release date of the latest app update
static void UOvrRequestsBlueprintLibrary::Application_InstallAppUpdateAndRelaunch
( UObject * WorldContextObject,
FLatentActionInfo LatentInfo,
FOvrApplicationOptions DeeplinkOptions,
FOvrAppDownloadResult & AppDownloadResult,
FString & 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.
Parameters
DeeplinkOptions
- Additional configuration for this relaunch. Optional.
static void UOvrRequestsBlueprintLibrary::Application_LaunchOtherApp
( UObject * WorldContextObject,
FLatentActionInfo LatentInfo,
FOvrId AppID,
FOvrApplicationOptions DeeplinkOptions,
FString & StringPayload,
FString & 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
Parameters
AppID
- The ID of the app to launch
DeeplinkOptions
- Additional configuration for this requests. Optional.
static void UOvrRequestsBlueprintLibrary::Application_StartAppDownload
( UObject * WorldContextObject,
FLatentActionInfo LatentInfo,
FOvrAppDownloadResult & AppDownloadResult,
FString & ErrorMsg )
Starts an app download. It will return a result when the download is finished. Download progress can be monitored using the check_app_download_progress API.
static void UOvrRequestsBlueprintLibrary::AssetFile_DeleteById
( UObject * WorldContextObject,
FLatentActionInfo LatentInfo,
FOvrId AssetFileID,
FOvrAssetFileDeleteResult & AssetFileDeleteResult,
FString & ErrorMsg )
Removes an previously installed asset file from the device by its ID. Returns an object containing the asset ID and file name, and a success flag.
Parameters
AssetFileID
- The asset file ID
static void UOvrRequestsBlueprintLibrary::AssetFile_DeleteByName
( UObject * WorldContextObject,
FLatentActionInfo LatentInfo,
FString AssetFileName,
FOvrAssetFileDeleteResult & AssetFileDeleteResult,
FString & ErrorMsg )
Removes an previously installed asset file from the device by its name. Returns an object containing the asset ID and file name, and a success flag.
Parameters
AssetFileName
- The asset file name
static void UOvrRequestsBlueprintLibrary::AssetFile_DownloadById
( UObject * WorldContextObject,
FLatentActionInfo LatentInfo,
FOvrId AssetFileID,
FOvrAssetFileDownloadResult & AssetFileDownloadResult,
FString & ErrorMsg )
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
static void UOvrRequestsBlueprintLibrary::AssetFile_DownloadByName
( UObject * WorldContextObject,
FLatentActionInfo LatentInfo,
FString AssetFileName,
FOvrAssetFileDownloadResult & AssetFileDownloadResult,
FString & 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.
Parameters
AssetFileName
- The asset file name
static void UOvrRequestsBlueprintLibrary::AssetFile_DownloadCancelById
( UObject * WorldContextObject,
FLatentActionInfo LatentInfo,
FOvrId AssetFileID,
FOvrAssetFileDownloadCancelResult & AssetFileDownloadCancelResult,
FString & 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.
Parameters
AssetFileID
- The asset file ID
static void UOvrRequestsBlueprintLibrary::AssetFile_DownloadCancelByName
( UObject * WorldContextObject,
FLatentActionInfo LatentInfo,
FString AssetFileName,
FOvrAssetFileDownloadCancelResult & AssetFileDownloadCancelResult,
FString & 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.
Parameters
AssetFileName
- The asset file name
static void UOvrRequestsBlueprintLibrary::AssetFile_GetList
( UObject * WorldContextObject,
FLatentActionInfo LatentInfo,
TArray< FOvrAssetDetails > & AssetDetailsArray,
FString & ErrorMsg )
Returns an array of objects with asset file names and their associated IDs, and and whether it's currently installed.
static void UOvrRequestsBlueprintLibrary::AssetFile_StatusById
( UObject * WorldContextObject,
FLatentActionInfo LatentInfo,
FOvrId AssetFileID,
FOvrAssetDetails & AssetDetails,
FString & ErrorMsg )
Returns the details on a single asset: ID, file name, and whether it's currently installed
Parameters
AssetFileID
- The asset file ID
static void UOvrRequestsBlueprintLibrary::AssetFile_StatusByName
( UObject * WorldContextObject,
FLatentActionInfo LatentInfo,
FString AssetFileName,
FOvrAssetDetails & AssetDetails,
FString & ErrorMsg )
Returns the details on a single asset: ID, file name, and whether it's currently installed
Parameters
AssetFileName
- The asset file name
static void UOvrRequestsBlueprintLibrary::Avatar_LaunchAvatarEditor
( UObject * WorldContextObject,
FLatentActionInfo LatentInfo,
FOvrAvatarEditorResult & AvatarEditorResult,
FString & ErrorMsg )
Launches the Avatar Editor
static void UOvrRequestsBlueprintLibrary::Challenges_Create
( UObject * WorldContextObject,
FLatentActionInfo LatentInfo,
FString LeaderboardName,
FOvrChallengeOptions ChallengeOptions,
FOvrChallenge & Challenge,
FString & ErrorMsg )
DEPRECATED. Use server-to-server API call instead.
static void UOvrRequestsBlueprintLibrary::Challenges_DeclineInvite
( UObject * WorldContextObject,
FLatentActionInfo LatentInfo,
FOvrId ChallengeID,
FOvrChallenge & Challenge,
FString & ErrorMsg )
If the current user has an invite to the challenge, decline the invite
static void UOvrRequestsBlueprintLibrary::Challenges_Delete
( UObject * WorldContextObject,
FLatentActionInfo LatentInfo,
FOvrId ChallengeID,
FString & ErrorMsg )
DEPRECATED. Use server-to-server API call instead.
static void UOvrRequestsBlueprintLibrary::Challenges_Get
( UObject * WorldContextObject,
FLatentActionInfo LatentInfo,
FOvrId ChallengeID,
FOvrChallenge & Challenge,
FString & ErrorMsg )
Gets the information for a single challenge
Parameters
ChallengeID
- The id of the challenge whose entries to return.
static void UOvrRequestsBlueprintLibrary::Challenges_GetEntries
( UObject * WorldContextObject,
FLatentActionInfo LatentInfo,
FOvrId ChallengeID,
int32 Limit,
FOvrChallengeEntryPages & ChallengeEntryPages,
FString & ErrorMsg )
Requests a block of challenge entries.
Parameters
ChallengeID
- The id of the challenge 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 challenge.
static void UOvrRequestsBlueprintLibrary::Challenges_GetEntriesAfterRank
( UObject * WorldContextObject,
FLatentActionInfo LatentInfo,
FOvrId ChallengeID,
int32 Limit,
int64 AfterRank,
FOvrChallengeEntryPages & ChallengeEntryPages,
FString & ErrorMsg )
Requests a block of challenge entries.
Parameters
ChallengeID
- The id of the challenge whose entries to return.
Limit
- The maximum number of entries to return.
AfterRank
- The position after which to start. For example, 10 returns challenge results starting with the 11th user.
static void UOvrRequestsBlueprintLibrary::Challenges_GetEntriesByIds
( UObject * WorldContextObject,
FLatentActionInfo LatentInfo,
FOvrId ChallengeID,
int32 Limit,
TArray< FOvrId > UserIDs,
FOvrChallengeEntryPages & ChallengeEntryPages,
FString & ErrorMsg )
Requests a block of challenge entries. Will return only entries matching the user IDs passed in.
Parameters
ChallengeID
- The id of the challenge 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 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.
static void UOvrRequestsBlueprintLibrary::Challenges_GetList
( UObject * WorldContextObject,
FLatentActionInfo LatentInfo,
FOvrChallengeOptions ChallengeOptions,
int32 Limit,
FOvrChallengePages & ChallengePages,
FString & ErrorMsg )
Requests for a list of challenge
static void UOvrRequestsBlueprintLibrary::Challenges_Join
( UObject * WorldContextObject,
FLatentActionInfo LatentInfo,
FOvrId ChallengeID,
FOvrChallenge & Challenge,
FString & ErrorMsg )
If the current user has permission, join the challenge
static void UOvrRequestsBlueprintLibrary::Challenges_Leave
( UObject * WorldContextObject,
FLatentActionInfo LatentInfo,
FOvrId ChallengeID,
FOvrChallenge & Challenge,
FString & ErrorMsg )
If the current user has permission, leave the challenge
static void UOvrRequestsBlueprintLibrary::Challenges_UpdateInfo
( UObject * WorldContextObject,
FLatentActionInfo LatentInfo,
FOvrId ChallengeID,
FOvrChallengeOptions ChallengeOptions,
FOvrChallenge & Challenge,
FString & ErrorMsg )
DEPRECATED. Use server-to-server API call instead.
static void UOvrRequestsBlueprintLibrary::Cowatching_GetPresenterData
( UObject * WorldContextObject,
FLatentActionInfo LatentInfo,
FString & StringPayload,
FString & ErrorMsg )
Presenter data is used to drive a cowatching session. This can be called when there is an active cowatching session.
static void UOvrRequestsBlueprintLibrary::Cowatching_GetViewersData
( UObject * WorldContextObject,
FLatentActionInfo LatentInfo,
FOvrCowatchViewerPages & CowatchViewerPages,
FString & ErrorMsg )
Get the viewer data of everyone who is in a cowatching session whose data was set by Cowatching_SetViewerData(). This can be called when there is an active cowatching session.
static void UOvrRequestsBlueprintLibrary::Cowatching_IsInSession
( UObject * WorldContextObject,
FLatentActionInfo LatentInfo,
FOvrCowatchingState & CowatchingState,
FString & ErrorMsg )
Check whether the current user is in the current cowatching session.
static void UOvrRequestsBlueprintLibrary::Cowatching_JoinSession
( UObject * WorldContextObject,
FLatentActionInfo LatentInfo,
FString & ErrorMsg )
Join the current cowatching session. Viewer data can only be updated by users who are in the session.
static void UOvrRequestsBlueprintLibrary::Cowatching_LaunchInviteDialog
( UObject * WorldContextObject,
FLatentActionInfo LatentInfo,
FString & ErrorMsg )
Launch a dialog for inviting users to cowatch in Copresent Home.
static void UOvrRequestsBlueprintLibrary::Cowatching_LeaveSession
( UObject * WorldContextObject,
FLatentActionInfo LatentInfo,
FString & ErrorMsg )
Leave the current cowatching session. Viewer data will no longer be relevant.
static void UOvrRequestsBlueprintLibrary::Cowatching_RequestToPresent
( UObject * WorldContextObject,
FLatentActionInfo LatentInfo,
FString & ErrorMsg )
Request to start a cowatching session as the presenter while copresent in home.
static void UOvrRequestsBlueprintLibrary::Cowatching_ResignFromPresenting
( UObject * WorldContextObject,
FLatentActionInfo LatentInfo,
FString & ErrorMsg )
Stop being the presenter. This will end the cowatching session.
static void UOvrRequestsBlueprintLibrary::Cowatching_SetPresenterData
( UObject * WorldContextObject,
FLatentActionInfo LatentInfo,
FString VideoTitle,
FString PresenterData,
FString & ErrorMsg )
Set the data that drives a cowatching session. This method is only callable by the presenter. Video title cannot exceed 100 characters, and data size is limited to 500 characters. The data will be eventually consistent across all users.
static void UOvrRequestsBlueprintLibrary::Cowatching_SetViewerData
( UObject * WorldContextObject,
FLatentActionInfo LatentInfo,
FString ViewerData,
FString & ErrorMsg )
Set the current user's viewer data to be shared with copresent users. This can be called when there is an active cowatching session. Data size is limited to 500 characters. The data will be eventually consistent across all users.
static void UOvrRequestsBlueprintLibrary::DeviceApplicationIntegrity_GetIntegrityToken
( UObject * WorldContextObject,
FLatentActionInfo LatentInfo,
FString ChallengeNonce,
FString & StringPayload,
FString & 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).
static void UOvrRequestsBlueprintLibrary::Entitlement_GetIsViewerEntitled
( UObject * WorldContextObject,
FLatentActionInfo LatentInfo,
FString & ErrorMsg )
Returns whether the current user is entitled to the current app.
static void UOvrRequestsBlueprintLibrary::GroupPresence_Clear
( UObject * WorldContextObject,
FLatentActionInfo LatentInfo,
FString & ErrorMsg )
Clear group presence for running app
static void UOvrRequestsBlueprintLibrary::GroupPresence_GetInvitableUsers
( UObject * WorldContextObject,
FLatentActionInfo LatentInfo,
FOvrUserPages & UserPages,
FString & 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.
static void UOvrRequestsBlueprintLibrary::GroupPresence_GetSentInvites
( UObject * WorldContextObject,
FLatentActionInfo LatentInfo,
FOvrApplicationInvitePages & ApplicationInvitePages,
FString & ErrorMsg )
Get the application invites which have been sent by the user.
static void UOvrRequestsBlueprintLibrary::GroupPresence_LaunchInvitePanel
( UObject * WorldContextObject,
FLatentActionInfo LatentInfo,
FOvrInvitePanelResultInfo & InvitePanelResultInfo,
FString & ErrorMsg )
Launch the flow to allow the user to invite others to their current session. This can only be used if the user is in a joinable session.
static void UOvrRequestsBlueprintLibrary::GroupPresence_LaunchMultiplayerErrorDialog
( UObject * WorldContextObject,
FLatentActionInfo LatentInfo,
FString & ErrorMsg )
Launch an error dialog with predefined messages for common multiplayer errors.
static void UOvrRequestsBlueprintLibrary::GroupPresence_LaunchRejoinDialog
( UObject * WorldContextObject,
FLatentActionInfo LatentInfo,
FString LobbySessionId,
FString MatchSessionId,
FString DestinationApiName,
FOvrRejoinDialogResult & RejoinDialogResult,
FString & ErrorMsg )
Launch the dialog which will allow the user to rejoin a previous lobby/match. Either the lobby_session_id or the match_session_id, or both, must be populated.
static void UOvrRequestsBlueprintLibrary::GroupPresence_LaunchRosterPanel
( UObject * WorldContextObject,
FLatentActionInfo LatentInfo,
FString & ErrorMsg )
Launch the panel which displays the current users in the roster. Users with the same lobby and match session id as part of their presence will show up here.
static void UOvrRequestsBlueprintLibrary::GroupPresence_SendInvites
( UObject * WorldContextObject,
FLatentActionInfo LatentInfo,
TArray< FOvrId > UserIDs,
FOvrSendInvitesResult & SendInvitesResult,
FString & ErrorMsg )
Send application invites to the passed in userIDs.
static void UOvrRequestsBlueprintLibrary::GroupPresence_Set
( UObject * WorldContextObject,
FLatentActionInfo LatentInfo,
FOvrGroupPresenceOptions GroupPresenceOptions,
FString & ErrorMsg )
Set group presence for running app
static void UOvrRequestsBlueprintLibrary::GroupPresence_SetDeeplinkMessageOverride
( UObject * WorldContextObject,
FLatentActionInfo LatentInfo,
FString DeeplinkMessage,
FString & ErrorMsg )
Set the user's deeplink message while keeping the other group presence parameters the same. If the destination of the user is not set, the deeplink message cannot be set as there's no deeplink message to override.
static void UOvrRequestsBlueprintLibrary::GroupPresence_SetDestination
( UObject * WorldContextObject,
FLatentActionInfo LatentInfo,
FString ApiName,
FString & ErrorMsg )
Replaces the user's current destination for the provided one. All other existing group presence parameters will remain the same.
static void UOvrRequestsBlueprintLibrary::GroupPresence_SetIsJoinable
( UObject * WorldContextObject,
FLatentActionInfo LatentInfo,
bool IsJoinable,
FString & ErrorMsg )
Set if the current user's destination and session is joinable while keeping the other group presence parameters the same. If the destination or session ids of the user is not set, they cannot be set to joinable.
static void UOvrRequestsBlueprintLibrary::GroupPresence_SetLobbySession
( UObject * WorldContextObject,
FLatentActionInfo LatentInfo,
FString Id,
FString & ErrorMsg )
Replaces the user's current lobby session id for the provided one. All other existing group presence parameters will remain the same.
static void UOvrRequestsBlueprintLibrary::GroupPresence_SetMatchSession
( UObject * WorldContextObject,
FLatentActionInfo LatentInfo,
FString Id,
FString & ErrorMsg )
Replaces the user's current match session id for the provided one. All other existing group presence parameters will remain the same.
static void UOvrRequestsBlueprintLibrary::IAP_ConsumePurchase
( UObject * WorldContextObject,
FLatentActionInfo LatentInfo,
FString Sku,
FString & ErrorMsg )
Allow the consumable IAP product to be purchased again. Conceptually, this indicates that the item was used or consumed.
static void UOvrRequestsBlueprintLibrary::IAP_GetProductsBySKU
( UObject * WorldContextObject,
FLatentActionInfo LatentInfo,
TArray< FString > Skus,
FOvrProductPages & ProductPages,
FString & ErrorMsg )
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.
static void UOvrRequestsBlueprintLibrary::IAP_GetViewerPurchases
( UObject * WorldContextObject,
FLatentActionInfo LatentInfo,
FOvrPurchasePages & PurchasePages,
FString & 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.
static void UOvrRequestsBlueprintLibrary::IAP_GetViewerPurchasesDurableCache
( UObject * WorldContextObject,
FLatentActionInfo LatentInfo,
FOvrPurchasePages & PurchasePages,
FString & 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. It is recommended in all cases to use ovr_User_GetViewerPurchases first and only check the cache if that fails.
static void UOvrRequestsBlueprintLibrary::IAP_LaunchCheckoutFlow
( UObject * WorldContextObject,
FLatentActionInfo LatentInfo,
FString Sku,
FOvrPurchase & Purchase,
FString & 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 resolveit, 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.
static void UOvrRequestsBlueprintLibrary::LanguagePack_GetCurrent
( UObject * WorldContextObject,
FLatentActionInfo LatentInfo,
FOvrAssetDetails & AssetDetails,
FString & ErrorMsg )
Returns currently installed and selected language pack for an app in the view of the asset_details. Use language field to extract neeeded language info. A particular language can be download and installed by a user from the Oculus app on the application page.
static void UOvrRequestsBlueprintLibrary::LanguagePack_SetCurrent
( UObject * WorldContextObject,
FLatentActionInfo LatentInfo,
FString Tag,
FOvrAssetFileDownloadResult & AssetFileDownloadResult,
FString & 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 AssetFile_DownloadByName() request, and sends periodic FOvrNotification_AssetFile_DownloadUpdate to track the downloads. Once the language asset file is downloaded, call LanguagePack_GetCurrent() to retrive the data, and use the language at runtime.
Parameters
Tag
- BCP47 language tag
static void UOvrRequestsBlueprintLibrary::Leaderboard_Get
( UObject * WorldContextObject,
FLatentActionInfo LatentInfo,
FString LeaderboardName,
FOvrLeaderboardPages & LeaderboardPages,
FString & ErrorMsg )
Gets the information for a single leaderboard
Parameters
LeaderboardName
- The name of the leaderboard to return.
static void UOvrRequestsBlueprintLibrary::Leaderboard_GetEntries
( UObject * WorldContextObject,
FLatentActionInfo LatentInfo,
FString LeaderboardName,
int32 Limit,
FOvrLeaderboardEntryPages & LeaderboardEntryPages,
FString & ErrorMsg )
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.
static void UOvrRequestsBlueprintLibrary::Leaderboard_GetEntriesAfterRank
( UObject * WorldContextObject,
FLatentActionInfo LatentInfo,
FString LeaderboardName,
int32 Limit,
int64 AfterRank,
FOvrLeaderboardEntryPages & LeaderboardEntryPages,
FString & ErrorMsg )
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.
static void UOvrRequestsBlueprintLibrary::Leaderboard_GetEntriesByIds
( UObject * WorldContextObject,
FLatentActionInfo LatentInfo,
FString LeaderboardName,
int32 Limit,
TArray< FOvrId > UserIDs,
FOvrLeaderboardEntryPages & LeaderboardEntryPages,
FString & ErrorMsg )
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.
static void UOvrRequestsBlueprintLibrary::Leaderboard_WriteEntry
( UObject * WorldContextObject,
FLatentActionInfo LatentInfo,
FString LeaderboardName,
int64 Score,
TArray< uint8 > ExtraData,
bool ForceUpdate,
FOvrLeaderboardUpdateStatus & LeaderboardUpdateStatus,
FString & ErrorMsg )
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.
static void UOvrRequestsBlueprintLibrary::Leaderboard_WriteEntryWithSupplementaryMetric
( UObject * WorldContextObject,
FLatentActionInfo LatentInfo,
FString LeaderboardName,
int64 Score,
int64 SupplementaryMetric,
TArray< uint8 > ExtraData,
bool ForceUpdate,
FOvrLeaderboardUpdateStatus & LeaderboardUpdateStatus,
FString & ErrorMsg )
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 ecen if it is not the user's best score.
static void UOvrRequestsBlueprintLibrary::Media_ShareToFacebook
( UObject * WorldContextObject,
FLatentActionInfo LatentInfo,
FString PostTextSuggestion,
FString FilePath,
EOvrMediaContentType ContentType,
FOvrShareMediaResult & ShareMediaResult,
FString & ErrorMsg )
Launch the Share to Facebook modal via a deeplink to Home on Gear VR, allowing users to share local media files to Facebook. Accepts a postTextSuggestion string for the default text of the Facebook post. Requires a filePath string as the path to the image to be shared to Facebook. This image should be located in your app's internal storage directory. Requires a contentType indicating the type of media to be shared (only 'photo' is currently supported.)
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
static void UOvrRequestsBlueprintLibrary::Notification_MarkAsRead
( UObject * WorldContextObject,
FLatentActionInfo LatentInfo,
FOvrId NotificationID,
FString & ErrorMsg )
Mark a notification as read. This causes it to disappear from the Universal Menu, the Oculus App, Oculus Home, and in-app retrieval.
static void UOvrRequestsBlueprintLibrary::Party_GetCurrent
( UObject * WorldContextObject,
FLatentActionInfo LatentInfo,
FOvrParty & Party,
FString & ErrorMsg )
Load the party the current user is in.
static void UOvrRequestsBlueprintLibrary::RichPresence_Clear
( UObject * WorldContextObject,
FLatentActionInfo LatentInfo,
FString & ErrorMsg )
DEPRECATED. Use the clear method in group presence
static void UOvrRequestsBlueprintLibrary::RichPresence_GetDestinations
( UObject * WorldContextObject,
FLatentActionInfo LatentInfo,
FOvrDestinationPages & DestinationPages,
FString & ErrorMsg )
Gets all the destinations that the presence can be set to
static void UOvrRequestsBlueprintLibrary::User_Get
( UObject * WorldContextObject,
FLatentActionInfo LatentInfo,
FOvrId UserID,
FOvrUser & User,
FString & 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.
Parameters
UserID
- User ID retrieved with this application.
static void UOvrRequestsBlueprintLibrary::User_GetAccessToken
( UObject * WorldContextObject,
FLatentActionInfo LatentInfo,
FString & StringPayload,
FString & ErrorMsg )
Return an access token for this user, suitable for making REST calls against graph.oculus.com.
static void UOvrRequestsBlueprintLibrary::User_GetBlockedUsers
( UObject * WorldContextObject,
FLatentActionInfo LatentInfo,
FOvrBlockedUserPages & BlockedUserPages,
FString & ErrorMsg )
Return the IDs of users entitled to use the current app that are blocked by the specified user
static void UOvrRequestsBlueprintLibrary::User_GetLoggedInUser
( UObject * WorldContextObject,
FLatentActionInfo LatentInfo,
FOvrUser & User,
FString & ErrorMsg )
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.
static void UOvrRequestsBlueprintLibrary::User_GetLoggedInUserFriends
( UObject * WorldContextObject,
FLatentActionInfo LatentInfo,
FOvrUserPages & UserPages,
FString & ErrorMsg )
Retrieve a list of the logged in user's bidirectional followers.
static void UOvrRequestsBlueprintLibrary::User_GetOrgScopedID
( UObject * WorldContextObject,
FLatentActionInfo LatentInfo,
FOvrId UserID,
FOvrOrgScopedID & OrgScopedID,
FString & ErrorMsg )
returns an ovrID which is unique per org. allows different apps within the same org to identify the user.
Parameters
UserID
- to load the org scoped id of
static void UOvrRequestsBlueprintLibrary::User_GetSdkAccounts
( UObject * WorldContextObject,
FLatentActionInfo LatentInfo,
TArray< FOvrSdkAccount > & SdkAccountArray,
FString & ErrorMsg )
Returns all accounts belonging to this user. Accounts are the Oculus user and x-users that are linked to this user.
static void UOvrRequestsBlueprintLibrary::User_GetUserProof
( UObject * WorldContextObject,
FLatentActionInfo LatentInfo,
FOvrUserProof & UserProof,
FString & ErrorMsg )
Part of the scheme to confirm the identity of a particular user in your backend. You can pass the result of User_GetUserProof() and a user ID from User_Get() to your your backend. Your server can then use our api to verify identity. 'https://graph.oculus.com/user_nonce_validate?nonce=USER_PROOF&user_id=USER_ID&access_token=ACCESS_TOKEN'
NOTE: The nonce is only good for one check and then it is invalidated.
static void UOvrRequestsBlueprintLibrary::User_LaunchBlockFlow
( UObject * WorldContextObject,
FLatentActionInfo LatentInfo,
FOvrId UserID,
FOvrLaunchBlockFlowResult & LaunchBlockFlowResult,
FString & 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.
Parameters
UserID
- User ID of user being blocked
static void UOvrRequestsBlueprintLibrary::User_LaunchFriendRequestFlow
( UObject * WorldContextObject,
FLatentActionInfo LatentInfo,
FOvrId UserID,
FOvrLaunchFriendRequestFlowResult & LaunchFriendRequestFlowResult,
FString & ErrorMsg )
Launch the flow for sending a follow request to a user.
Parameters
UserID
- User ID of user to send a follow request to
static void UOvrRequestsBlueprintLibrary::User_LaunchUnblockFlow
( UObject * WorldContextObject,
FLatentActionInfo LatentInfo,
FOvrId UserID,
FOvrLaunchUnblockFlowResult & LaunchUnblockFlowResult,
FString & ErrorMsg )
Launch the flow for unblocking a user that the viewer has blocked.
Parameters
UserID
- User ID of user to unblock
static void UOvrRequestsBlueprintLibrary::UserAgeCategory_Get
( UObject * WorldContextObject,
FLatentActionInfo LatentInfo,
FOvrUserAccountAgeCategory & UserAccountAgeCategory,
FString & ErrorMsg )
Retrieve the user age category for the current user.
static void UOvrRequestsBlueprintLibrary::UserAgeCategory_Report
( UObject * WorldContextObject,
FLatentActionInfo LatentInfo,
EOvrAppAgeCategory AgeCategory,
FString & ErrorMsg )
Report the current user's age category to Meta.
static void UOvrRequestsBlueprintLibrary::Voip_GetMicrophoneAvailability
( UObject * WorldContextObject,
FLatentActionInfo LatentInfo,
FOvrMicrophoneAvailabilityState & MicrophoneAvailabilityState,
FString & 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.
static void UOvrRequestsBlueprintLibrary::Voip_SetSystemVoipSuppressed
( UObject * WorldContextObject,
FLatentActionInfo LatentInfo,
bool Suppressed,
FOvrSystemVoipState & SystemVoipState,
FString & ErrorMsg )
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

UOvrRequestsBlueprintLibrary::UFUNCTION
( BlueprintCallable ,
meta ,
Category )
DEPRECATED. Use AssetFile_DeleteById()
UOvrRequestsBlueprintLibrary::UFUNCTION
( BlueprintCallable ,
meta ,
Category )
DEPRECATED. Use AssetFile_DownloadById()
UOvrRequestsBlueprintLibrary::UFUNCTION
( BlueprintCallable ,
meta ,
Category )
UOvrRequestsBlueprintLibrary::UFUNCTION
( BlueprintCallable ,
meta ,
Category )
DEPRECATED. Use AssetFile_StatusById()
UOvrRequestsBlueprintLibrary::UFUNCTION
( BlueprintCallable ,
meta ,
Category )
DEPRECATED. Use GroupPresence_Set().
Did you find this page helpful?
Thumbs up icon
Thumbs down icon