AccelByte.Api.Challenge Class Reference

Provide an API to access Challenge service. More...

Inheritance diagram for AccelByte.Api.Challenge:

Public Member Functions
void	GetChallenges (GetChallengesOptionalParamenters optionalParameters, ResultCallback< ChallengeResponse > callback)
	Send a request to get challenges.
void	GetChallenges (ResultCallback< ChallengeResponse > callback)
	Send a request to get all challenges.
void	GetScheduledChallengeGoals (string challengeCode, ResultCallback< GoalResponse > callback, string[] tags=null, int offset=0, int limit=20)
	Send a request to get all scheduled goals for a specific challenge.
void	GetChallengeProgress (string challengeCode, string goalCode, ResultCallback< GoalProgressionResponse > callback, int offset=0, int limit=20)
	Send a request to get current progress for a specific challenge.
void	GetRewards (ChallengeRewardStatus status, ResultCallback< UserRewards > callback, ChallengeSortBy sortBy=ChallengeSortBy.UpdatedAtDesc, int offset=0, int limit=20)
	Send a request to get status of all challenge rewards.
void	ClaimReward (string[] rewardIDs, ResultCallback< UserReward[]> callback)
	Send a request to claim a single reward.
void	GetChallengeProgress (string challengeCode, int rotationIndex, ResultCallback< GoalProgressionResponse > callback, string goalCode="", int offset=0, int limit=20)
	Send a request to get progress for a specific challenge in a previous rotation cycle.
void	EvaluateChallengeProgress (ResultCallback callback)
	Send a request to attempt to evaluate the current user's challenge progress.
void	EvaluateChallengeProgress (EvaluateChallengeProgressOptionalParameters optionalParameters, ResultCallback callback)
	Send a request to attempt to evaluate the current user's challenge progress.
void	ListScheduleByGoal (string challengeCode, string goalCode, ResultCallback< ChallengeListScheduleByGoalResponse > callback)
	List schedules of given goal in a challenge for specific user.
void	ListScheduleByGoal (string challengeCode, string goalCode, ChallengeListScheduleByGoalOptionalParameters optionalParams, ResultCallback< ChallengeListScheduleByGoalResponse > callback)
	List schedules of given goal in a challenge for specific user.
void	ListSchedules (string challengeCode, ResultCallback< ChallengeListSchedulesResponse > callback)
	List schedules of given challenge for specific user.
void	ListSchedules (string challengeCode, ChallengeListSchedulesOptionalParameters optionalParams, ResultCallback< ChallengeListSchedulesResponse > callback)
	List schedules of given challenge for specific user.

Additional Inherited Members
Properties inherited from AccelByte.Core.WrapperBase
Utils.AccelByteIdValidator	IdValidator [get]

Detailed Description

Provide an API to access Challenge service.

Member Function Documentation

ClaimReward()

void AccelByte.Api.Challenge.ClaimReward ( string[] rewardIDs, ResultCallback< UserReward[]> callback )

inline

Send a request to claim a single reward.

Parameters

rewardIDs	List of rewardID to be claimed
callback	Api Result Callback

Implements AccelByte.Api.Interface.IClientChallenge.

EvaluateChallengeProgress() [1/2]

void AccelByte.Api.Challenge.EvaluateChallengeProgress ( EvaluateChallengeProgressOptionalParameters optionalParam, ResultCallback callback )

inline

Send a request to attempt to evaluate the current user's challenge progress.

Parameters

optionalParam	optional parameter to evaluate challenge progress
callback	ResultCallback if operation is successful or not

Implements AccelByte.Api.Interface.IClientChallenge.

EvaluateChallengeProgress() [2/2]

void AccelByte.Api.Challenge.EvaluateChallengeProgress ( ResultCallback callback )

inline

Send a request to attempt to evaluate the current user's challenge progress.

Parameters

callback

ResultCallback if operation is successful or not

Implements AccelByte.Api.Interface.IClientChallenge.

GetChallengeProgress() [1/2]

void AccelByte.Api.Challenge.GetChallengeProgress ( string challengeCode, int rotationIndex, ResultCallback< GoalProgressionResponse > callback, string goalCode = "", int offset = 0, int limit = 20 )

inline

Send a request to get progress for a specific challenge in a previous rotation cycle.

Parameters

challengeCode	String code for the challenge to check progress for
rotationIndex	Index for rotation, treat rotation as an array sorted by the start time of a rotation in descending manner. 0 indicates current or latest active rotation. Increment the value to refer to specific past rotation
callback	Api Result Callback
goalCode	String code for the specific challenge goal to get progress for
offset
limit

Implements AccelByte.Api.Interface.IClientChallenge.

GetChallengeProgress() [2/2]

void AccelByte.Api.Challenge.GetChallengeProgress ( string challengeCode, string goalCode, ResultCallback< GoalProgressionResponse > callback, int offset = 0, int limit = 20 )

inline

Send a request to get current progress for a specific challenge.

Parameters

challengeCode	String code for the challenge to check progress for
goalCode	String code for the specific challenge goal to get progress for
callback	Api Result Callback
offset	Number of scheduled goals to skip when returning goals list, defaults to 0
limit	Number of scheduled goals that should be included in the goals list, defaults to 20

Implements AccelByte.Api.Interface.IClientChallenge.

GetChallenges() [1/2]

void AccelByte.Api.Challenge.GetChallenges ( GetChallengesOptionalParamenters optionalParameters, ResultCallback< ChallengeResponse > callback )

inline

Send a request to get challenges.

Parameters

optionalParameters	Optional parameter to get challenges list
callback	Api Result Callback

Implements AccelByte.Api.Interface.IClientChallenge.

GetChallenges() [2/2]

void AccelByte.Api.Challenge.GetChallenges ( ResultCallback< ChallengeResponse > callback )

inline

Send a request to get all challenges.

Parameters

callback

Api Result Callback

Implements AccelByte.Api.Interface.IClientChallenge.

GetRewards()

void AccelByte.Api.Challenge.GetRewards ( ChallengeRewardStatus status, ResultCallback< UserRewards > callback, ChallengeSortBy sortBy = ChallengeSortBy.UpdatedAtDesc, int offset = 0, int limit = 20 )

inline

Send a request to get status of all challenge rewards.

Parameters

status	Determines what specific rewards should be included in the response
callback	Api Result Callback
sortBy	Determines the order in which the rewards in the response are returned
offset	Number of rewards to skip when returning reward list, defaults to 0
limit	Number of rewards to include when returning reward list, defaults to 20

Implements AccelByte.Api.Interface.IClientChallenge.

GetScheduledChallengeGoals()

void AccelByte.Api.Challenge.GetScheduledChallengeGoals ( string challengeCode, ResultCallback< GoalResponse > callback, string[] tags = null, int offset = 0, int limit = 20 )

inline

Send a request to get all scheduled goals for a specific challenge.

Parameters

challengeCode	String code for the challenge to check scheduled goals for
callback	Api Result Callback
tags	Array of tag strings used to filter resulting goals list
offset	Number of scheduled goals to skip when returning goals list, defaults to 0
limit	Number of scheduled goals that should be included in the goals list, defaults to 20

Implements AccelByte.Api.Interface.IClientChallenge.

ListScheduleByGoal() [1/2]

void AccelByte.Api.Challenge.ListScheduleByGoal ( string challengeCode, string goalCode, ChallengeListScheduleByGoalOptionalParameters optionalParams, ResultCallback< ChallengeListScheduleByGoalResponse > callback )

inline

List schedules of given goal in a challenge for specific user.

Parameters

challengeCode	Challenge code
goalCode	Goal code
optionalParams	Optional parameter to list challenge schedules
callback	Api Result Callback

Implements AccelByte.Api.Interface.IClientChallenge.

ListScheduleByGoal() [2/2]

void AccelByte.Api.Challenge.ListScheduleByGoal ( string challengeCode, string goalCode, ResultCallback< ChallengeListScheduleByGoalResponse > callback )

inline

List schedules of given goal in a challenge for specific user.

Parameters

challengeCode	Challenge code
goalCode	Goal code
callback	Api Result Callback

Implements AccelByte.Api.Interface.IClientChallenge.

ListSchedules() [1/2]

void AccelByte.Api.Challenge.ListSchedules ( string challengeCode, ChallengeListSchedulesOptionalParameters optionalParams, ResultCallback< ChallengeListSchedulesResponse > callback )

inline

List schedules of given challenge for specific user.

Parameters

challengeCode	Challenge code
optionalParams	Optional parameter to list challenge schedules. To query schedules prior to specific date time, use dateTime parameter.
callback	Api Result Callback

Implements AccelByte.Api.Interface.IClientChallenge.

ListSchedules() [2/2]

void AccelByte.Api.Challenge.ListSchedules ( string challengeCode, ResultCallback< ChallengeListSchedulesResponse > callback )

inline

List schedules of given challenge for specific user.

Parameters

challengeCode	Challenge code
callback	Api Result Callback

Implements AccelByte.Api.Interface.IClientChallenge.