PICO Unreal Platform SDK
|
PicoChallengesInterface class. More...
#include <Pico_Challenges.h>
Public Member Functions | |
bool | Get (const FString &ChallengeID, FChallengeGet InGetDelegate) |
Gets a specified challenge by ID. More... | |
bool | GetEntries (const FString &ChallengeID, int PageIdx, int PageSize, ELeaderboardFilterType Filter, ELeaderboardStartAt StartAt, FChallengeGetEntries InGetEntriesDelegate) |
Gets a list of challenge entries. More... | |
bool | GetEntriesAfterRank (ppfID ChallengeID, int PageIdx, int PageSize, unsigned long long AfterRank, FChallengeGetEntriesAfterRank InGetEntriesAfterRankDelegate) |
Gets the challenge entries after a specified ranking. More... | |
bool | GetEntriesByIds (const FString &ChallengeID, int PageIdx, int PageSize, ELeaderboardStartAt StartAt, const TArray< FString > &UserIDs, FChallengeGetEntriesByIds InGetEntriesByIdsDelegate) |
Gets the challenge entries for specified user(s). More... | |
bool | GetList (FPico_ChallengeOptions ChallengeOptions, int PageIdx, int PageSize, FChallengeGetList InGetListDelegate) |
Gets a list of challenges. More... | |
bool | Join (const FString &ChallengeID, FChallengeJoin InJoinDelegate) |
Lets the current user join a challenge. More... | |
bool | Leave (const FString &ChallengeID, FChallengeLeave InLeaveDelegate) |
Lets the current user leave a challenge. More... | |
bool | Invite (const FString &ChallengeID, const TArray< FString > &UserIDs, FChallengeInvite Delegate) |
Invites user(s) to join a challenge. More... | |
bool | LaunchInvitableUserFlow (const FString &ChallengeID, FChallengeLaunchInvitableUserFlow Delegate) |
Launches the invitation flow to let the current user invite friends to a specified challenge. This launches the system default invite UI where the user can select friends to invite and then send invitations to them. Therefore, this is a shortcut if you do not want to build the invite UI by yourself. More... | |
PicoChallengesInterface class.
bool Get | ( | const FString & | ChallengeID, |
FChallengeGet | InGetDelegate | ||
) |
Gets a specified challenge by ID.
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). |
true
: success false
: failure bool GetEntries | ( | const FString & | ChallengeID, |
int | PageIdx, | ||
int | PageSize, | ||
ELeaderboardFilterType | Filter, | ||
ELeaderboardStartAt | StartAt, | ||
FChallengeGetEntries | InGetEntriesDelegate | ||
) |
Gets a list of challenge entries.
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:
|
StartAt | Defines where to start returning challenge entries, the enumerations are:
|
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). |
true
: success false
: failure
bool GetEntriesAfterRank | ( | ppfID | ChallengeID, |
int | PageIdx, | ||
int | PageSize, | ||
unsigned long long | AfterRank, | ||
FChallengeGetEntriesAfterRank | InGetEntriesAfterRankDelegate | ||
) |
Gets the challenge entries after a specified ranking.
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). |
true
: success false
: failure
bool GetEntriesByIds | ( | const FString & | ChallengeID, |
int | PageIdx, | ||
int | PageSize, | ||
ELeaderboardStartAt | StartAt, | ||
const TArray< FString > & | UserIDs, | ||
FChallengeGetEntriesByIds | InGetEntriesByIdsDelegate | ||
) |
Gets the challenge entries for specified user(s).
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:
|
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). |
true
: success false
: failure
bool GetList | ( | FPico_ChallengeOptions | ChallengeOptions, |
int | PageIdx, | ||
int | PageSize, | ||
FChallengeGetList | InGetListDelegate | ||
) |
Gets a list of challenges.
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. |
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. |
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). |
true
: success false
: failure
bool Invite | ( | const FString & | ChallengeID, |
const TArray< FString > & | UserIDs, | ||
FChallengeInvite | Delegate | ||
) |
Invites user(s) to join a challenge.
ChallengeID | Challenge ID. |
UserIDs | User ID(s). |
<param name="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).
true
: success false
: failure
bool Join | ( | const FString & | ChallengeID, |
FChallengeJoin | InJoinDelegate | ||
) |
Lets the current user join a challenge.
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). |
true
: success false
: failure
bool LaunchInvitableUserFlow | ( | const FString & | ChallengeID, |
FChallengeLaunchInvitableUserFlow | Delegate | ||
) |
Launches the invitation flow to let the current user invite friends to a specified challenge. This launches the system default invite UI where the user can select friends to invite and then send invitations to them. Therefore, this is a shortcut if you do not want to build the invite UI by yourself.
ChallengeID | Challenge ID. |
<param name="Delegate>Will be executed when the request has been completed.
Delegate will contain the requested object class (bool, bIsError, int, ErrorCode, const FString&, ErrorMessage).
true
: success false
: failure
bool Leave | ( | const FString & | ChallengeID, |
FChallengeLeave | InLeaveDelegate | ||
) |
Lets the current user leave a challenge.
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). |
true
: success false
: failure