UOnlinePicoChallengesFunction Class Reference

OnlinePicoChallenges Blueprint Function class. More...

#include <Pico_Challenges.h>

Static Public Member Functions
static void	Get (UObject *WorldContextObject, const FString &ChallengeID, FChallengeGet InGetDelegate)
	Gets a specified challenge by ID. More...
static void	GetEntries (UObject *WorldContextObject, const FString &ChallengeID, int PageIdx, int PageSize, ELeaderboardFilterType Filter, ELeaderboardStartAt StartAt, FChallengeGetEntries InGetEntriesDelegate)
	Gets a list of challenge entries. More...
static void	GetEntriesAfterRank (UObject *WorldContextObject, const FString &ChallengeID, int PageIdx, int PageSize, const FString &AfterRank, FChallengeGetEntriesAfterRank InGetEntriesAfterRankDelegate)
	Gets the challenge entries after a specified ranking. More...
static void	GetEntriesByIds (UObject *WorldContextObject, const FString &ChallengeID, int PageIdx, int PageSize, ELeaderboardStartAt StartAt, const TArray< FString > &UserIDs, FChallengeGetEntriesByIds InGetEntriesByIdsDelegate)
	Gets the challenge entries for specified user(s). More...
static void	GetList (UObject *WorldContextObject, FPico_ChallengeOptions ChallengeOptions, int PageIdx, int PageSize, FChallengeGetList InGetListDelegate)
	Gets a list of challenges. More...
static void	Join (UObject *WorldContextObject, const FString &ChallengeID, FChallengeJoin InJoinDelegate)
	Lets the current user join a challenge. More...
static void	Leave (UObject *WorldContextObject, const FString &ChallengeID, FChallengeLeave InLeaveDelegate)
	Lets the current user leave a challenge. More...
static void	Invite (UObject *WorldContextObject, const FString &ChallengeID, const TArray< FString > &UserIDs, FChallengeInvite Delegate)
	Invites user(s) to join a challenge. More...
static void	LaunchInvitableUserFlow (UObject *WorldContextObject, const FString &ChallengeID, FChallengeLaunchInvitableUserFlow Delegate)
	Launches the invitation flow to let the current user invite friends to a specified challenge. More...

Detailed Description

OnlinePicoChallenges Blueprint Function class.

Member Function Documentation

Get()

static void Get ( UObject *  WorldContextObject, const FString &  ChallengeID, FChallengeGet  InGetDelegate  )

static

Gets a specified challenge by ID.

Parameters

WorldContextObject	Used to get the information about the current world.
ChallengeID	Challenge ID.
InGetDelegate	Will be executed when the request has been completed. Delegate will contain the requested object class (FChallengeGet, bool, bIsError, const FString&, ErrorMessage, UPico_Challenge *, Challenge).

GetEntries()

static void GetEntries ( UObject *  WorldContextObject, const FString &  ChallengeID, int  PageIdx, int  PageSize, ELeaderboardFilterType  Filter, ELeaderboardStartAt  StartAt, FChallengeGetEntries  InGetEntriesDelegate  )

static

Gets a list of challenge entries.

Parameters

WorldContextObject	Used to get the information about the current world.
ChallengeID	Challenge ID.
PageIdx	Defines which page of entries to return. The value = (The target page No.)-1. For example, if you want to get the first page of entries, pass 0; if you want to get the second page of entries, pass 1.
PageSize	The number of entries to return on each page.
Filter	Restricts the scope of entries to return: NONE: returns all entries of the specified leaderboard FRIENDS: returns the entries of the friends of the current logged-in user USER_IDS(do not pass this value): returns the entries of specified users
StartAt	Defines where to start returning challenge entries, the enumerations are: 0: Top (return entries from top 1) 1: CenteredOnViewer (place the current logged-in user's entry in the middle of the list on the first page. For example, if the total number of entries is 10, pageSize is set to 5, and the user's rank is top 5, the ranks displayed on the first page will be top 3, 4, 5, 6, and 7. Top 1 and 2 will not be displayed, and top 8, 9, and 10 will be displayed on the second page) 2: CenteredOnViewerOrTop (place the current logged-in user's entry on the top of the list on the first page. For example, if the total number of entries is 10, pageSize is set to 5, and the user's rank is top 5, the ranks displayed on the first page will be top 5, 6, 7, 8, and 9. Top 1, 2, 3, and 4 will not be displayed, and top 10 will be displayed on the second page)
InGetEntriesDelegate	Will be executed when the request has been completed. Delegate will contain the requested object class (bool, bIsError, const FString&, ErrorMessage, UPico_ChallengeEntryArray *, ChallengeEntryList).

GetEntriesAfterRank()

static void GetEntriesAfterRank ( UObject *  WorldContextObject, const FString &  ChallengeID, int  PageIdx, int  PageSize, const FString &  AfterRank, FChallengeGetEntriesAfterRank  InGetEntriesAfterRankDelegate  )

static

Gets the challenge entries after a specified ranking.

Parameters

WorldContextObject	Used to get the information about the current world.
ChallengeID	Challenge ID.
PageIdx	Defines which page of entries to return. The value = (The target page No.)-1. For example, if you want to get the first page of entries, pass 0; if you want to get the second page of entries, pass 1.
PageSize	The number of entries to return on each page.
AfterRank	Defines after which rank to return entries.
InGetEntriesAfterRankDelegate	Will be executed when the request has been completed. Delegate will contain the requested object class (bool, bIsError, const FString&, ErrorMessage, UPico_ChallengeEntryArray *, ChallengeEntryList).

GetEntriesByIds()

static void GetEntriesByIds ( UObject *  WorldContextObject, const FString &  ChallengeID, int  PageIdx, int  PageSize, ELeaderboardStartAt  StartAt, const TArray< FString > &  UserIDs, FChallengeGetEntriesByIds  InGetEntriesByIdsDelegate  )

static

Gets the challenge entries for specified user(s).

Parameters

WorldContextObject	Used to get the information about the current world.
ChallengeID	Challenge ID.
PageIdx	Defines which page of entries to return. The value = (The target page No.)-1. For example, if you want to get the first page of entries, pass 0; if you want to get the second page of entries, pass 1.
PageSize	The number of entries to return on each page.
StartAt	Defines where to start returning challenge entries, the enumerations are: 0: Top (return entries from top 1) 1: CenteredOnViewer (place the current logged-in user's entry in the middle of the list on the first page. For example, if the total number of entries is 10, pageSize is set to 5, and the user's rank is top 5, the ranks displayed on the first page will be top 3, 4, 5, 6, and 7. Top 1 and 2 will not be displayed, and top 8, 9, and 10 will be displayed on the second page) 2: CenteredOnViewerOrTop (place the current logged-in user's entry on the top of the list on the first page. For example, if the total number of entries is 10, pageSize is set to 5, and the user's rank is top 5, the ranks displayed on the first page will be top 5, 6, 7, 8, and 9. Top 1, 2, 3, and 4 will not be displayed, and top 10 will be displayed on the second page)
UserIDs	User ID(s).
InGetEntriesByIdsDelegate	Will be executed when the request has been completed. Delegate will contain the requested object class (bool, bIsError, const FString&, ErrorMessage, UPico_ChallengeEntryArray *, ChallengeEntryList).

GetList()

static void GetList ( UObject *  WorldContextObject, FPico_ChallengeOptions  ChallengeOptions, int  PageIdx, int  PageSize, FChallengeGetList  InGetListDelegate  )

static

Gets a list of challenges.

Parameters

WorldContextObject

Used to get the information about the current world.

ChallengeOptions

Restricts the scope of challenges to return. You can define the start date and end date of challenges, the leaderboard the challenges belong to, etc. Parameters PageIdx Defines which page of challenges to return. The value = (The target page No.)-1. For example, if you want to get the first page of entries, pass 0; if you want to get the second page of entries, pass 1. PageSize The number of challenges to return on each page. InGetListDelegate Will be executed when the request has been completed. Delegate will contain the requested object class (bool, bIsError, const FString&, ErrorMessage, UPico_ChallengeArray *, ChallengeList).

Invite()

static void Invite ( UObject *  WorldContextObject, const FString &  ChallengeID, const TArray< FString > &  UserIDs, FChallengeInvite  Delegate  )

static

Invites user(s) to join a challenge.

Parameters

WorldContextObject	Used to get the information about the current world.
ChallengeID	Challenge ID.
UserIDs	User ID(s).
Delegate	Will be executed when the request has been completed. Delegate will contain the requested object class (bool, bIsError, const FString&, ErrorMessage, UPico_Challenge *, Challenge).

Join()

static void Join ( UObject *  WorldContextObject, const FString &  ChallengeID, FChallengeJoin  InJoinDelegate  )

static

Lets the current user join a challenge.

Parameters

WorldContextObject	Used to get the information about the current world.
ChallengeID	Challenge ID.
InJoinDelegate	Will be executed when the request has been completed. Delegate will contain the requested object class (bool, bIsError, const FString&, ErrorMessage, UPico_Challenge *, Challenge).

LaunchInvitableUserFlow()

static void LaunchInvitableUserFlow ( UObject *  WorldContextObject, const FString &  ChallengeID, FChallengeLaunchInvitableUserFlow  Delegate  )

static

Launches the invitation flow to let the current user invite friends to a specified challenge.

Parameters

WorldContextObject	Used to get the information about the current world.
ChallengeID	Challenge ID.
Delegate	Will be executed when the request has been completed. Delegate will contain the requested object class (bool, bIsError, int, ErrorCode, const FString&, ErrorMessage).

Leave()

static void Leave ( UObject *  WorldContextObject, const FString &  ChallengeID, FChallengeLeave  InLeaveDelegate  )

static

Lets the current user leave a challenge.

Parameters

WorldContextObject	Used to get the information about the current world.
ChallengeID	Challenge ID.
InLeaveDelegate	Will be executed when the request has been completed. Delegate will contain the requested object class (bool, bIsError, const FString&, ErrorMessage, UPico_Challenge *, Challenge).