AccelByte.Api.Achievement Class Reference

Provide APIs to access Achievement service. More...

Inheritance diagram for AccelByte.Api.Achievement:

Public Member Functions
void	QueryAchievements (string language, AchievementSortBy sortBy, ResultCallback< PaginatedPublicAchievement > callback, int offset=0, int limit=20, TagQueryBuilder tagBuilder=null, bool isGlobal=false)
	Query all achievements in the related namespace.
void	GetAchievement (string achievementCode, ResultCallback< MultiLanguageAchievement > callback)
	Get an specific achievement information.
void	QueryUserAchievements (AchievementSortBy sortBy, ResultCallback< PaginatedUserAchievement > callback, int offset=0, int limit=20, bool preferUnlocked=true, TagQueryBuilder tagBuilder=null)
	Query user's achievements. Include achieved and in-progress.
void	UnlockAchievement (string achievementCode, ResultCallback callback)
	Unlock specific achievement.
void	BulkUnlockAchievement (string[] achievementCodes, ResultCallback< BulkUnlockAchievementResponse[]> callback)
	Unlock multiple achievements via achievementCode for the current user.
void	QueryGlobalAchievements (string achievementCode, GlobalAchievementStatus achievementStatus, GlobalAchievementListSortBy sortBy, ResultCallback< PaginatedUserGlobalAchievement > callback, int offset=0, int limit=20, TagQueryBuilder tagBuilder=null)
	Query the progress list of global achievements. Include achieved and in-progress.
void	QueryGlobalAchievementContributors (string achievementCode, GlobalAchievementContributorsSortBy sortBy, ResultCallback< PaginatedGlobalAchievementContributors > callback, int offset=0, int limit=20)
	Query the list of contributors for a global achievement.
void	QueryGlobalAchievementUserContributed (string achievementCode, GlobalAchievementContributorsSortBy sortBy, ResultCallback< PaginatedGlobalAchievementUserContributed > callback, int offset=0, int limit=20)
	Query the list of global achievements that have been contributed by the user.
void	ClaimGlobalAchievement (string achievementCode, ResultCallback callback)
	Claim specific global achievement.
void	GetTags (string name, AchievementSortBy sortBy, ResultCallback< PaginatedPublicTag > callback, int offset=0, int limit=20)
	Query all tags for achievements.

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

Detailed Description

Provide APIs to access Achievement service.

Member Function Documentation

BulkUnlockAchievement()

void AccelByte.Api.Achievement.BulkUnlockAchievement ( string[] achievementCodes, ResultCallback< BulkUnlockAchievementResponse[]> callback )

inline

Unlock multiple achievements via achievementCode for the current user.

Parameters

achievementCodes	Array of achievement codes to be unlocked.
callback	Returns a Result via callback that contains an array of BulkUnlockAchievementResponse when completed.

ClaimGlobalAchievement()

void AccelByte.Api.Achievement.ClaimGlobalAchievement ( string achievementCode, ResultCallback callback )

inline

Claim specific global achievement.

Parameters

achievementCode	The code of the expected global achievement.
callback	Returns a Result via callback when completed.

GetAchievement()

void AccelByte.Api.Achievement.GetAchievement ( string achievementCode, ResultCallback< MultiLanguageAchievement > callback )

inline

Get an specific achievement information.

Parameters

achievementCode	The code of the expected achievement.
callback	Returns a Result that contains MultiLanguageAchievement via callback when completed.

GetTags()

void AccelByte.Api.Achievement.GetTags ( string name, AchievementSortBy sortBy, ResultCallback< PaginatedPublicTag > callback, int offset = 0, int limit = 20 )

inline

Query all tags for achievements.

Parameters

name	The name of the expected tag
sortBy	Sorting method for the achievement tags result.
callback	Returns a Result that contains PaginatedPublicTag via callback when completed.
offset	The offset of the achievement result. Default value is 0.
limit	The limit of the achievement result. Default value is 20.

QueryAchievements()

void AccelByte.Api.Achievement.QueryAchievements ( string language, AchievementSortBy sortBy, ResultCallback< PaginatedPublicAchievement > callback, int offset = 0, int limit = 20, TagQueryBuilder tagBuilder = null, bool isGlobal = false )

inline

Query all achievements in the related namespace.

Parameters

language	The language to display the appropiate achievement's name and description. If it is empty, it will use the its default language. If the achievement does not have the expected language, it will use its dafault languge.
sortBy	Sorting method for the achievements result.
callback	Returns a Result that contains PaginatedPublicAchievement via callback when completed.
offset	The offset of the achievement result. Default value is 0.
limit	The limit of the achievement result. Default value is 20.

///

Parameters

tagBuilder	A query expression consists of tags to query the achievement from.
isGlobal	True if the configuration to display global achievements.

///

QueryGlobalAchievementContributors()

void AccelByte.Api.Achievement.QueryGlobalAchievementContributors ( string achievementCode, GlobalAchievementContributorsSortBy sortBy, ResultCallback< PaginatedGlobalAchievementContributors > callback, int offset = 0, int limit = 20 )

inline

Query the list of contributors for a global achievement.

Parameters

achievementCode	The code of the expected global achievement.
sortBy	Sorting method for the achievements result.
callback	Returns a Result that contains PaginatedGlobalAchievementContributors via callback when completed.
offset	The offset of the achievement result. Default value is 0.
limit	The limit of the achievement result. Default value is 20.

QueryGlobalAchievements()

void AccelByte.Api.Achievement.QueryGlobalAchievements ( string achievementCode, GlobalAchievementStatus achievementStatus, GlobalAchievementListSortBy sortBy, ResultCallback< PaginatedUserGlobalAchievement > callback, int offset = 0, int limit = 20, TagQueryBuilder tagBuilder = null )

inline

Query the progress list of global achievements. Include achieved and in-progress.

Parameters

achievementCode	The code of the expected global achievement.
achievementStatus	Achievement status for the achievements result.
sortBy	Sorting method for the achievements result.
callback	Returns a Result that contains PaginatedUserGlobalAchievement via callback when completed.
offset	The offset of the achievement result. Default value is 0.
limit	The limit of the achievement result. Default value is 20.
tagBuilder	A query expression consists of tags to query the achievement from.

QueryGlobalAchievementUserContributed()

void AccelByte.Api.Achievement.QueryGlobalAchievementUserContributed ( string achievementCode, GlobalAchievementContributorsSortBy sortBy, ResultCallback< PaginatedGlobalAchievementUserContributed > callback, int offset = 0, int limit = 20 )

inline

Query the list of global achievements that have been contributed by the user.

Parameters

achievementCode	The code of the expected achievement.
sortBy	Sorting method for the achievements result.
callback	Returns a Result that contains PaginatedGlobalAchievementUserContributed via callback when completed.
offset	The offset of the achievement result. Default value is 0.
limit	The limit of the achievement result. Default value is 20.

QueryUserAchievements()

void AccelByte.Api.Achievement.QueryUserAchievements ( AchievementSortBy sortBy, ResultCallback< PaginatedUserAchievement > callback, int offset = 0, int limit = 20, bool preferUnlocked = true, TagQueryBuilder tagBuilder = null )

inline

Query user's achievements. Include achieved and in-progress.

Parameters

sortBy	Sorting method for the achievements result.
callback	Returns a Result that contains PaginatedUserAchievement via callback when completed.
offset	The offset of the achievement result. Default value is 0.
limit	The limit of the achievement result. Default value is 20.
preferUnlocked	True if the configuration to display unlocked achievements first active, the list order should display unlocked achievements first on top of locked achievements, and false otherwise. Default value is true.
tagBuilder	A query expression consists of tags to query the achievement from.

UnlockAchievement()

void AccelByte.Api.Achievement.UnlockAchievement ( string achievementCode, ResultCallback callback )

inline

Unlock specific achievement.

Parameters

achievementCode	The achievement code which will be unlock.
callback	Returns a Result via callback when completed.