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

Inheritance diagram for AccelByte.Server.ServerChallenge:

Public Member Functions
void	ClaimReward (ChallengeBulkClaimRewardRequest[] challengeBulkClaimRewardRequest, ResultCallback< ChallengeBulkClaimRewardResponse[]> callback)
	Claim challenge rewards for multiple users.
void	ClaimReward (string userId, ClaimRewardRequest claimRewardRequest, ResultCallback< UserReward[]> callback)
	Claim challenge rewards for a single user.
void	CreateChallenge (CreateChallengeRequest createChallengeRequest, ResultCallback< ChallengeResponseInfo > callback)
	Create a new challenge in the current namespace.
void	CreateChallengeGoal (string challengeCode, CreateChallengeGoalRequest createChallengeGoalRequest, ResultCallback< GoalResponseInfo > callback)
	Create a new goal for a specified challenge in the current namespace.
void	DeleteChallenge (string challengeCode, ResultCallback callback)
	Delete a specified challenge in the current namespace.
void	DeleteChallengeGoal (string challengeCode, string goalCode, ResultCallback callback)
	Delete a specified goal for a specified challenge in the current namespace.
void	DeleteTiedChallenge (string challengeCode, ResultCallback callback)
	Delete a specified TIED challenge along with its goals, schedules, and player progressions in the current namespace.
void	EvaluateChallengeProgress (string[] userIds, ResultCallback callback)
	Send a request to attempt to evaluate many user's challenge progress.
void	EvaluateChallengeProgress (string[] userIds, EvaluateChallengeProgressOptionalParameters optionalParameters, ResultCallback callback)
	Send a request to attempt to evaluate many user's challenge progress.
void	GetChallenge (string challengeCode, ResultCallback< ChallengeResponseInfo > callback)
	Retrieve a specified challenge in the current namespace.
void	GetChallengeGoal (string challengeCode, string goalCode, ResultCallback< GoalResponseInfo > callback)
	Retrieve a specified goal for a specified challenge in the current namespace.
void	GetChallengeGoals (string challengeCode, ResultCallback< GoalResponse > callback, ChallengeSortBy challengeSortBy=ChallengeSortBy.UpdatedAtDesc, int offset=0, int limit=20)
	Retrieve a list of goals for a specified challenge in the current namespace.
void	GetChallengePeriods (string challengeCode, ResultCallback< ChallengePeriodResponse > callback, int offset=0, int limit=20)
	Retrieve a list of periods for a specified challenge in the current namespace.
void	GetChallenges (ResultCallback< ChallengeResponse > callback)
	Retrieve a list of challenges in the current namespace.
void	GetChallenges (GetChallengesOptionalParamenters optionalParameters, ResultCallback< ChallengeResponse > callback)
	Retrieve a list of challenges in the current namespace.
void	GetUserRewards (string userId, ResultCallback< UserRewards > callback, ChallengeRewardStatus challengeRewardStatus=ChallengeRewardStatus.None, ChallengeSortBy challengeSortBy=ChallengeSortBy.UpdatedAtDesc, int offset=0, int limit=20)
	Retrieve a list of a specified user's rewards in the current namespace.
void	RandomizeChallengeGoals (string challengeCode, ResultCallback< RandomizedChallengeResponse[]> callback)
	Utility endpoint to execute randomize goal schedule for a specified challenge in the current namespace that the AssignmentRule is set to RANDOMIZED and RandomizePerRotation is set to true.
void	UpdateChallenge (string challengeCode, UpdateChallengeRequest updateChallengeRequest, ResultCallback< ChallengeResponseInfo > callback)
	Update a specified challenge in the current namespace.
void	UpdateChallengeGoal (string challengeCode, string goalCode, UpdateChallengeGoalRequest updateChallengeGoalRequest, ResultCallback< GoalResponseInfo > callback)
	Update a specified goal for a specified challenge in the current namespace.

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() [1/2]

void AccelByte.Server.ServerChallenge.ClaimReward	(	ChallengeBulkClaimRewardRequest[]	challengeBulkClaimRewardRequest,
		ResultCallback< ChallengeBulkClaimRewardResponse[]>	callback )

inline

Claim challenge rewards for multiple users.

Parameters

challengeBulkClaimRewardRequest	Bulk claim reward request model
callback	Result callback of each user's rewards

Implements AccelByte.Server.Interface.IServerChallenge.

◆ ClaimReward() [2/2]

void AccelByte.Server.ServerChallenge.ClaimReward	(	string	userId,
		ClaimRewardRequest	claimRewardRequest,
		ResultCallback< UserReward[]>	callback )

inline

Claim challenge rewards for a single user.

Parameters

userId	User ID of user to claim rewards for
claimRewardRequest	Claim reward request model
callback	Result callback of the user's rewards

Implements AccelByte.Server.Interface.IServerChallenge.

◆ CreateChallenge()

void AccelByte.Server.ServerChallenge.CreateChallenge	(	CreateChallengeRequest	createChallengeRequest,
		ResultCallback< ChallengeResponseInfo >	callback )

inline

Create a new challenge in the current namespace.

Parameters

createChallengeRequest	Create challenge request model
callback	Result callback of the created challenge

Implements AccelByte.Server.Interface.IServerChallenge.

◆ CreateChallengeGoal()

void AccelByte.Server.ServerChallenge.CreateChallengeGoal	(	string	challengeCode,
		CreateChallengeGoalRequest	createChallengeGoalRequest,
		ResultCallback< GoalResponseInfo >	callback )

inline

Create a new goal for a specified challenge in the current namespace.

Parameters

challengeCode	String identifier of challenge to create a goal for
createChallengeGoalRequest	Create challenge goal request model
callback	Result callback of the created goal

Implements AccelByte.Server.Interface.IServerChallenge.

◆ DeleteChallenge()

void AccelByte.Server.ServerChallenge.DeleteChallenge	(	string	challengeCode,
		ResultCallback	callback )

inline

Delete a specified challenge in the current namespace.

Parameters

challengeCode	String identifier of challenge to be updated
callback	Result callback if deletion is successful or not

Implements AccelByte.Server.Interface.IServerChallenge.

◆ DeleteChallengeGoal()

void AccelByte.Server.ServerChallenge.DeleteChallengeGoal	(	string	challengeCode,
		string	goalCode,
		ResultCallback	callback )

inline

Delete a specified goal for a specified challenge in the current namespace.

Parameters

challengeCode	String identifier of challenge to delete a goal for
goalCode	String identifier of goal to delete
callback	Result callback if deletion is successful or not

Implements AccelByte.Server.Interface.IServerChallenge.

◆ DeleteTiedChallenge()

void AccelByte.Server.ServerChallenge.DeleteTiedChallenge	(	string	challengeCode,
		ResultCallback	callback )

inline

Delete a specified TIED challenge along with its goals, schedules, and player progressions in the current namespace.

Parameters

challengeCode	String identifier of TIED challenge to delete
callback	Result callback if deletion is successful or not

Implements AccelByte.Server.Interface.IServerChallenge.

◆ EvaluateChallengeProgress() [1/2]

void AccelByte.Server.ServerChallenge.EvaluateChallengeProgress	(	string[]	userIds,
		EvaluateChallengeProgressOptionalParameters	optionalParam,
		ResultCallback	callback )

inline

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

Parameters

userIds	List of the User IDs to be evaluated their challenge progress
optionalParam	optional parameter to evaluate challenge progress
callback	ResultCallback whether it success or failed

Implements AccelByte.Server.Interface.IServerChallenge.

◆ EvaluateChallengeProgress() [2/2]

void AccelByte.Server.ServerChallenge.EvaluateChallengeProgress	(	string[]	userIds,
		ResultCallback	callback )

inline

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

Parameters

userIds	List of the User IDs to be evaluated their challenge progress
callback	ResultCallback whether it success or failed

Implements AccelByte.Server.Interface.IServerChallenge.

◆ GetChallenge()

void AccelByte.Server.ServerChallenge.GetChallenge	(	string	challengeCode,
		ResultCallback< ChallengeResponseInfo >	callback )

inline

Retrieve a specified challenge in the current namespace.

Parameters

challengeCode	String identifier of challenge to be retrieved
callback	Result callback of the retrieved challenge

Implements AccelByte.Server.Interface.IServerChallenge.

◆ GetChallengeGoal()

void AccelByte.Server.ServerChallenge.GetChallengeGoal	(	string	challengeCode,
		string	goalCode,
		ResultCallback< GoalResponseInfo >	callback )

inline

Retrieve a specified goal for a specified challenge in the current namespace.

Parameters

challengeCode	String identifier of challenge to retrieve a goal for
goalCode	String identifier of goal to retrieve
callback	Result callback of the retrieved goal

Implements AccelByte.Server.Interface.IServerChallenge.

◆ GetChallengeGoals()

void AccelByte.Server.ServerChallenge.GetChallengeGoals	(	string	challengeCode,
		ResultCallback< GoalResponse >	callback,
		ChallengeSortBy	challengeSortBy = ChallengeSortBy.UpdatedAtDesc,
		int	offset = 0,
		int	limit = 20 )

inline

Retrieve a list of goals for a specified challenge in the current namespace.

Parameters

challengeCode	String identifier of challenge to retrieve goals for
callback	Result callback of retrieved goals
challengeSortBy	Determines the order in which the goals in the response are returned
offset	Number of goals to skip when returning goal list (default: 0)
limit	Number of goals to include in the returned goal list (default: 20)

Implements AccelByte.Server.Interface.IServerChallenge.

◆ GetChallengePeriods()

void AccelByte.Server.ServerChallenge.GetChallengePeriods	(	string	challengeCode,
		ResultCallback< ChallengePeriodResponse >	callback,
		int	offset = 0,
		int	limit = 20 )

inline

Retrieve a list of periods for a specified challenge in the current namespace.

Parameters

challengeCode	String identifier of challenge to retrieve periods for
callback	Result callback of periods for the specified challenge
limit	Number of periods to skip when returning period list (default: 0)
offset	Number of periods to include in the returned period list (default: 20)

Implements AccelByte.Server.Interface.IServerChallenge.

◆ GetChallenges() [1/2]

void AccelByte.Server.ServerChallenge.GetChallenges	(	GetChallengesOptionalParamenters	optionalParameters,
		ResultCallback< ChallengeResponse >	callback )

inline

Retrieve a list of challenges in the current namespace.

Parameters

optionalParameters
callback	Result callback of retrieved challenges

Implements AccelByte.Server.Interface.IServerChallenge.

◆ GetChallenges() [2/2]

void AccelByte.Server.ServerChallenge.GetChallenges ( ResultCallback< ChallengeResponse > callback )

inline

Retrieve a list of challenges in the current namespace.

Parameters

optionalParameters
callback	Result callback of retrieved challenges

Implements AccelByte.Server.Interface.IServerChallenge.

◆ GetUserRewards()

void AccelByte.Server.ServerChallenge.GetUserRewards	(	string	userId,
		ResultCallback< UserRewards >	callback,
		ChallengeRewardStatus	challengeRewardStatus = ChallengeRewardStatus.None,
		ChallengeSortBy	challengeSortBy = ChallengeSortBy.UpdatedAtDesc,
		int	offset = 0,
		int	limit = 20 )

inline

Retrieve a list of a specified user's rewards in the current namespace.

Parameters

userId	User ID of user to retrieve rewards for
callback	Result callback of the user's rewards
challengeRewardStatus	Status of rewards to query/filter
challengeSortBy	Determines the order in which the rewards in the response are returned
offset	Number of rewards to skip when returning reward list (default: 0)
limit	Number of rewards to include in the returned reward list (default: 20)

Implements AccelByte.Server.Interface.IServerChallenge.

◆ RandomizeChallengeGoals()

void AccelByte.Server.ServerChallenge.RandomizeChallengeGoals	(	string	challengeCode,
		ResultCallback< RandomizedChallengeResponse[]>	callback )

inline

Utility endpoint to execute randomize goal schedule for a specified challenge in the current namespace that the AssignmentRule is set to RANDOMIZED and RandomizePerRotation is set to true.

Parameters

challengeCode	String identifier of challenge to randomize goals for
callback	Result callback of challenge that has its goals randomized

Implements AccelByte.Server.Interface.IServerChallenge.

◆ UpdateChallenge()

void AccelByte.Server.ServerChallenge.UpdateChallenge	(	string	challengeCode,
		UpdateChallengeRequest	updateChallengeRequest,
		ResultCallback< ChallengeResponseInfo >	callback )

inline

Update a specified challenge in the current namespace.

Parameters

challengeCode	String identifier of challenge to be updated
updateChallengeRequest	Update challenge request model
callback	Result callback of the updated challenge

Implements AccelByte.Server.Interface.IServerChallenge.

◆ UpdateChallengeGoal()

void AccelByte.Server.ServerChallenge.UpdateChallengeGoal	(	string	challengeCode,
		string	goalCode,
		UpdateChallengeGoalRequest	updateChallengeGoalRequest,
		ResultCallback< GoalResponseInfo >	callback )

inline

Update a specified goal for a specified challenge in the current namespace.

Parameters

challengeCode	String identifier of challenge to update a goal for
goalCode	String identifier of goal to update
updateChallengeGoalRequest	Update challenge goal request model
callback	Result callback of the updated goal

Implements AccelByte.Server.Interface.IServerChallenge.

Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ ClaimReward() [1/2]

◆ ClaimReward() [2/2]

◆ CreateChallenge()

◆ CreateChallengeGoal()

◆ DeleteChallenge()

◆ DeleteChallengeGoal()

◆ DeleteTiedChallenge()

◆ EvaluateChallengeProgress() [1/2]

◆ EvaluateChallengeProgress() [2/2]

◆ GetChallenge()

◆ GetChallengeGoal()

◆ GetChallengeGoals()

◆ GetChallengePeriods()

◆ GetChallenges() [1/2]

◆ GetChallenges() [2/2]

◆ GetUserRewards()

◆ RandomizeChallengeGoals()

◆ UpdateChallenge()

◆ UpdateChallengeGoal()