API reference

UOvrPageRequestsBlueprintLibrary Class

Extends UBlueprintFunctionLibrary
UOvrPageRequestsBlueprintLibrary provides a set of functions for fetching pages of data from a paged array that can be used to interact with the Oculus platform.These functions include methods for handling achievements, application invites, blocking, challenges, cowatching, destinations, leaderboards, IAP, and user information. See more info about Platform Solution here.

Static Member Functions

FetchAchievementDefinitionPage ( WorldContextObject , InExecs , OutExecs , LatentInfo , AchievementDefinitionPages , AchievementDefinitionArray , bHasNextPage , ErrorMsg )
Fetches a page from an FOvrAchievementDefinitionPages paged array.
Signature
static void UOvrPageRequestsBlueprintLibrary::FetchAchievementDefinitionPage(UObject *WorldContextObject, const EOvrForwardArrayIteratorInputPins &InExecs, EOvrPageRequestOutputPins &OutExecs, FLatentActionInfo LatentInfo, const FOvrAchievementDefinitionPages &AchievementDefinitionPages, TArray< FOvrAchievementDefinition > &AchievementDefinitionArray, bool &bHasNextPage, FString &ErrorMsg)
Parameters
WorldContextObject: UObject *  - the world context
InExecs: const EOvrForwardArrayIteratorInputPins &  - an array of input pins that will be executed as a result of this request.
OutExecs: EOvrPageRequestOutputPins &  - an array of output pins that will be executed as a result of this request.
LatentInfo: FLatentActionInfo  - information about the latent action that will be performed as a result of this request.
AchievementDefinitionPages: const FOvrAchievementDefinitionPages &  - a FOvrAchievementDefinitionPages
AchievementDefinitionArray: TArray< FOvrAchievementDefinition > &  - an array of FOvrAchievementDefinition
bHasNextPage: bool &  - if more pages are available after this one.
ErrorMsg: FString &  - error message if the request failed, which contains failure reason, it is empty if the request succeeded.
Returns
void
FetchAchievementProgressPage ( WorldContextObject , InExecs , OutExecs , LatentInfo , AchievementProgressPages , AchievementProgressArray , bHasNextPage , ErrorMsg )
Fetches a page from an FOvrAchievementProgressPages paged array.
Signature
static void UOvrPageRequestsBlueprintLibrary::FetchAchievementProgressPage(UObject *WorldContextObject, const EOvrForwardArrayIteratorInputPins &InExecs, EOvrPageRequestOutputPins &OutExecs, FLatentActionInfo LatentInfo, const FOvrAchievementProgressPages &AchievementProgressPages, TArray< FOvrAchievementProgress > &AchievementProgressArray, bool &bHasNextPage, FString &ErrorMsg)
Parameters
WorldContextObject: UObject *  - the world context
InExecs: const EOvrForwardArrayIteratorInputPins &  - an array of input pins that will be executed as a result of this request.
OutExecs: EOvrPageRequestOutputPins &  - an array of output pins that will be executed as a result of this request.
LatentInfo: FLatentActionInfo  - information about the latent action that will be performed as a result of this request.
AchievementProgressPages: const FOvrAchievementProgressPages &  - a FOvrAchievementProgressPages
AchievementProgressArray: TArray< FOvrAchievementProgress > &  - an array of FOvrAchievementProgress
bHasNextPage: bool &  - if more pages are available after this one.
ErrorMsg: FString &  - error message if the request failed, which contains failure reason, it is empty if the request succeeded.
Returns
void
FetchApplicationInvitePage ( WorldContextObject , InExecs , OutExecs , LatentInfo , ApplicationInvitePages , ApplicationInviteArray , bHasNextPage , ErrorMsg )
Fetches a page from an FOvrApplicationInvitePages paged array.
Signature
static void UOvrPageRequestsBlueprintLibrary::FetchApplicationInvitePage(UObject *WorldContextObject, const EOvrForwardArrayIteratorInputPins &InExecs, EOvrPageRequestOutputPins &OutExecs, FLatentActionInfo LatentInfo, const FOvrApplicationInvitePages &ApplicationInvitePages, TArray< FOvrApplicationInvite > &ApplicationInviteArray, bool &bHasNextPage, FString &ErrorMsg)
Parameters
WorldContextObject: UObject *  - the world context
InExecs: const EOvrForwardArrayIteratorInputPins &  - an array of input pins that will be executed as a result of this request.
OutExecs: EOvrPageRequestOutputPins &  - an array of output pins that will be executed as a result of this request.
LatentInfo: FLatentActionInfo  - information about the latent action that will be performed as a result of this request.
ApplicationInvitePages: const FOvrApplicationInvitePages &  - a FOvrApplicationInvitePages
ApplicationInviteArray: TArray< FOvrApplicationInvite > &  - an array of FOvrApplicationInvite
bHasNextPage: bool &  - if more pages are available after this one.
ErrorMsg: FString &  - error message if the request failed, which contains failure reason, it is empty if the request succeeded.
Returns
void
FetchBlockedUserPage ( WorldContextObject , InExecs , OutExecs , LatentInfo , BlockedUserPages , BlockedUserArray , bHasNextPage , ErrorMsg )
Fetches a page from an FOvrBlockedUserPages paged array.
Signature
static void UOvrPageRequestsBlueprintLibrary::FetchBlockedUserPage(UObject *WorldContextObject, const EOvrForwardArrayIteratorInputPins &InExecs, EOvrPageRequestOutputPins &OutExecs, FLatentActionInfo LatentInfo, const FOvrBlockedUserPages &BlockedUserPages, TArray< FOvrBlockedUser > &BlockedUserArray, bool &bHasNextPage, FString &ErrorMsg)
Parameters
WorldContextObject: UObject *  - the world context
InExecs: const EOvrForwardArrayIteratorInputPins &  - an array of input pins that will be executed as a result of this request.
OutExecs: EOvrPageRequestOutputPins &  - an array of output pins that will be executed as a result of this request.
LatentInfo: FLatentActionInfo  - information about the latent action that will be performed as a result of this request.
BlockedUserPages: const FOvrBlockedUserPages &  - a FOvrBlockedUserPages
BlockedUserArray: TArray< FOvrBlockedUser > &  - an array of FOvrBlockedUser
bHasNextPage: bool &  - if more pages are available after this one.
ErrorMsg: FString &  - error message if the request failed, which contains failure reason, it is empty if the request succeeded.
Returns
void
FetchChallengeEntryPage ( WorldContextObject , InExecs , OutExecs , LatentInfo , ChallengeEntryPages , ChallengeEntryArray , bHasNextPage , bHasPreviousPage , ErrorMsg )
Fetches a page from a bidirectional FOvrChallengeEntryPages paged array.
Signature
static void UOvrPageRequestsBlueprintLibrary::FetchChallengeEntryPage(UObject *WorldContextObject, const EOvrBidirectionalArrayIteratorInputPins &InExecs, EOvrPageRequestOutputPins &OutExecs, FLatentActionInfo LatentInfo, const FOvrChallengeEntryPages &ChallengeEntryPages, TArray< FOvrChallengeEntry > &ChallengeEntryArray, bool &bHasNextPage, bool &bHasPreviousPage, FString &ErrorMsg)
Parameters
WorldContextObject: UObject *  - the world context
InExecs: const EOvrBidirectionalArrayIteratorInputPins &  - an array of input pins that will be executed as a result of this request.
OutExecs: EOvrPageRequestOutputPins &  - an array of output pins that will be executed as a result of this request.
LatentInfo: FLatentActionInfo  - information about the latent action that will be performed as a result of this request.
ChallengeEntryPages: const FOvrChallengeEntryPages &  - a FOvrChallengeEntryPages
ChallengeEntryArray: TArray< FOvrChallengeEntry > &  - an array of FOvrChallengeEntry
bHasNextPage: bool &  - if more pages are available after this one.
bHasPreviousPage: bool &  - if more pages are available before this one.
ErrorMsg: FString &  - error message if the request failed, which contains failure reason, it is empty if the request succeeded.
Returns
void
FetchChallengePage ( WorldContextObject , InExecs , OutExecs , LatentInfo , ChallengePages , ChallengeArray , bHasNextPage , bHasPreviousPage , ErrorMsg )
Fetches a page from a bidirectional FOvrChallengePages paged array.
Signature
static void UOvrPageRequestsBlueprintLibrary::FetchChallengePage(UObject *WorldContextObject, const EOvrBidirectionalArrayIteratorInputPins &InExecs, EOvrPageRequestOutputPins &OutExecs, FLatentActionInfo LatentInfo, const FOvrChallengePages &ChallengePages, TArray< FOvrChallenge > &ChallengeArray, bool &bHasNextPage, bool &bHasPreviousPage, FString &ErrorMsg)
Parameters
WorldContextObject: UObject *  - the world context
InExecs: const EOvrBidirectionalArrayIteratorInputPins &  - an array of input pins that will be executed as a result of this request.
OutExecs: EOvrPageRequestOutputPins &  - an array of output pins that will be executed as a result of this request.
LatentInfo: FLatentActionInfo  - information about the latent action that will be performed as a result of this request.
ChallengePages: const FOvrChallengePages &  - a FOvrChallengePages
ChallengeArray: TArray< FOvrChallenge > &  - an array of FOvrChallenge
bHasNextPage: bool &  - if more pages are available after this one.
bHasPreviousPage: bool &  - if more pages are available before this one.
ErrorMsg: FString &  - error message if the request failed, which contains failure reason, it is empty if the request succeeded.
Returns
void
FetchDestinationPage ( WorldContextObject , InExecs , OutExecs , LatentInfo , DestinationPages , DestinationArray , bHasNextPage , ErrorMsg )
Fetches a page from an FOvrDestinationPages paged array.
Signature
static void UOvrPageRequestsBlueprintLibrary::FetchDestinationPage(UObject *WorldContextObject, const EOvrForwardArrayIteratorInputPins &InExecs, EOvrPageRequestOutputPins &OutExecs, FLatentActionInfo LatentInfo, const FOvrDestinationPages &DestinationPages, TArray< FOvrDestination > &DestinationArray, bool &bHasNextPage, FString &ErrorMsg)
Parameters
WorldContextObject: UObject *  - the world context
InExecs: const EOvrForwardArrayIteratorInputPins &  - an array of input pins that will be executed as a result of this request.
OutExecs: EOvrPageRequestOutputPins &  - an array of output pins that will be executed as a result of this request.
LatentInfo: FLatentActionInfo  - information about the latent action that will be performed as a result of this request.
DestinationPages: const FOvrDestinationPages &  - a FOvrDestinationPages
DestinationArray: TArray< FOvrDestination > &  - an array of FOvrDestination
bHasNextPage: bool &  - if more pages are available after this one.
ErrorMsg: FString &  - error message if the request failed, which contains failure reason, it is empty if the request succeeded.
Returns
void
FetchLeaderboardEntryPage ( WorldContextObject , InExecs , OutExecs , LatentInfo , LeaderboardEntryPages , LeaderboardEntryArray , bHasNextPage , bHasPreviousPage , ErrorMsg )
Fetches a page from a bidirectional FOvrLeaderboardEntryPages paged array.
Signature
static void UOvrPageRequestsBlueprintLibrary::FetchLeaderboardEntryPage(UObject *WorldContextObject, const EOvrBidirectionalArrayIteratorInputPins &InExecs, EOvrPageRequestOutputPins &OutExecs, FLatentActionInfo LatentInfo, const FOvrLeaderboardEntryPages &LeaderboardEntryPages, TArray< FOvrLeaderboardEntry > &LeaderboardEntryArray, bool &bHasNextPage, bool &bHasPreviousPage, FString &ErrorMsg)
Parameters
WorldContextObject: UObject *  - the world context
InExecs: const EOvrBidirectionalArrayIteratorInputPins &  - an array of input pins that will be executed as a result of this request.
OutExecs: EOvrPageRequestOutputPins &  - an array of output pins that will be executed as a result of this request.
LatentInfo: FLatentActionInfo  - information about the latent action that will be performed as a result of this request.
LeaderboardEntryPages: const FOvrLeaderboardEntryPages &  - a FOvrLeaderboardEntryPages
LeaderboardEntryArray: TArray< FOvrLeaderboardEntry > &  - an array of FOvrLeaderboardEntry
bHasNextPage: bool &  - if more pages are available after this one.
bHasPreviousPage: bool &  - if more pages are available before this one.
ErrorMsg: FString &  - error message if the request failed, which contains failure reason, it is empty if the request succeeded.
Returns
void
FetchLeaderboardPage ( WorldContextObject , InExecs , OutExecs , LatentInfo , LeaderboardPages , LeaderboardArray , bHasNextPage , ErrorMsg )
Fetches a page from an FOvrLeaderboardPages paged array.
Signature
static void UOvrPageRequestsBlueprintLibrary::FetchLeaderboardPage(UObject *WorldContextObject, const EOvrForwardArrayIteratorInputPins &InExecs, EOvrPageRequestOutputPins &OutExecs, FLatentActionInfo LatentInfo, const FOvrLeaderboardPages &LeaderboardPages, TArray< FOvrLeaderboard > &LeaderboardArray, bool &bHasNextPage, FString &ErrorMsg)
Parameters
WorldContextObject: UObject *  - the world context
InExecs: const EOvrForwardArrayIteratorInputPins &  - an array of input pins that will be executed as a result of this request.
OutExecs: EOvrPageRequestOutputPins &  - an array of output pins that will be executed as a result of this request.
LatentInfo: FLatentActionInfo  - information about the latent action that will be performed as a result of this request.
LeaderboardPages: const FOvrLeaderboardPages &  - a FOvrLeaderboardPages
LeaderboardArray: TArray< FOvrLeaderboard > &  - an array of FOvrLeaderboard
bHasNextPage: bool &  - if more pages are available after this one.
ErrorMsg: FString &  - error message if the request failed, which contains failure reason, it is empty if the request succeeded.
Returns
void
FetchProductPage ( WorldContextObject , InExecs , OutExecs , LatentInfo , ProductPages , ProductArray , bHasNextPage , ErrorMsg )
Fetches a page from an FOvrProductPages paged array.
Signature
static void UOvrPageRequestsBlueprintLibrary::FetchProductPage(UObject *WorldContextObject, const EOvrForwardArrayIteratorInputPins &InExecs, EOvrPageRequestOutputPins &OutExecs, FLatentActionInfo LatentInfo, const FOvrProductPages &ProductPages, TArray< FOvrProduct > &ProductArray, bool &bHasNextPage, FString &ErrorMsg)
Parameters
WorldContextObject: UObject *  - the world context
InExecs: const EOvrForwardArrayIteratorInputPins &  - an array of input pins that will be executed as a result of this request.
OutExecs: EOvrPageRequestOutputPins &  - an array of output pins that will be executed as a result of this request.
LatentInfo: FLatentActionInfo  - information about the latent action that will be performed as a result of this request.
ProductPages: const FOvrProductPages &  - a FOvrProductPages
ProductArray: TArray< FOvrProduct > &  - an array of FOvrProduct
bHasNextPage: bool &  - if more pages are available after this one.
ErrorMsg: FString &  - error message if the request failed, which contains failure reason, it is empty if the request succeeded.
Returns
void
FetchPurchasePage ( WorldContextObject , InExecs , OutExecs , LatentInfo , PurchasePages , PurchaseArray , bHasNextPage , ErrorMsg )
Fetches a page from an FOvrPurchasePages paged array.
Signature
static void UOvrPageRequestsBlueprintLibrary::FetchPurchasePage(UObject *WorldContextObject, const EOvrForwardArrayIteratorInputPins &InExecs, EOvrPageRequestOutputPins &OutExecs, FLatentActionInfo LatentInfo, const FOvrPurchasePages &PurchasePages, TArray< FOvrPurchase > &PurchaseArray, bool &bHasNextPage, FString &ErrorMsg)
Parameters
WorldContextObject: UObject *  - the world context
InExecs: const EOvrForwardArrayIteratorInputPins &  - an array of input pins that will be executed as a result of this request.
OutExecs: EOvrPageRequestOutputPins &  - an array of output pins that will be executed as a result of this request.
LatentInfo: FLatentActionInfo  - information about the latent action that will be performed as a result of this request.
PurchasePages: const FOvrPurchasePages &  - a FOvrPurchasePages
PurchaseArray: TArray< FOvrPurchase > &  - an array of FOvrPurchase
bHasNextPage: bool &  - if more pages are available after this one.
ErrorMsg: FString &  - error message if the request failed, which contains failure reason, it is empty if the request succeeded.
Returns
void
FetchUserCapabilityPage ( WorldContextObject , InExecs , OutExecs , LatentInfo , UserCapabilityPages , UserCapabilityArray , bHasNextPage , ErrorMsg )
Fetches a page from an FOvrUserCapabilityPages paged array.
Signature
static void UOvrPageRequestsBlueprintLibrary::FetchUserCapabilityPage(UObject *WorldContextObject, const EOvrForwardArrayIteratorInputPins &InExecs, EOvrPageRequestOutputPins &OutExecs, FLatentActionInfo LatentInfo, const FOvrUserCapabilityPages &UserCapabilityPages, TArray< FOvrUserCapability > &UserCapabilityArray, bool &bHasNextPage, FString &ErrorMsg)
Parameters
WorldContextObject: UObject *  - the world context
InExecs: const EOvrForwardArrayIteratorInputPins &  - an array of input pins that will be executed as a result of this request.
OutExecs: EOvrPageRequestOutputPins &  - an array of output pins that will be executed as a result of this request.
LatentInfo: FLatentActionInfo  - information about the latent action that will be performed as a result of this request.
UserCapabilityPages: const FOvrUserCapabilityPages &  - a FOvrUserCapabilityPages
UserCapabilityArray: TArray< FOvrUserCapability > &  - an array of FOvrUserCapability
bHasNextPage: bool &  - if more pages are available after this one.
ErrorMsg: FString &  - error message if the request failed, which contains failure reason, it is empty if the request succeeded.
Returns
void
FetchUserPage ( WorldContextObject , InExecs , OutExecs , LatentInfo , UserPages , UserArray , bHasNextPage , ErrorMsg )
Fetches a page from an FOvrUserPages paged array.
Signature
static void UOvrPageRequestsBlueprintLibrary::FetchUserPage(UObject *WorldContextObject, const EOvrForwardArrayIteratorInputPins &InExecs, EOvrPageRequestOutputPins &OutExecs, FLatentActionInfo LatentInfo, const FOvrUserPages &UserPages, TArray< FOvrUser > &UserArray, bool &bHasNextPage, FString &ErrorMsg)
Parameters
WorldContextObject: UObject *  - the world context
InExecs: const EOvrForwardArrayIteratorInputPins &  - an array of input pins that will be executed as a result of this request.
OutExecs: EOvrPageRequestOutputPins &  - an array of output pins that will be executed as a result of this request.
LatentInfo: FLatentActionInfo  - information about the latent action that will be performed as a result of this request.
UserPages: const FOvrUserPages &  - a FOvrUserPages
UserArray: TArray< FOvrUser > &  - an array of FOvrUser
bHasNextPage: bool &  - if more pages are available after this one.
ErrorMsg: FString &  - error message if the request failed, which contains failure reason, it is empty if the request succeeded.
Returns
void