Inheritance diagram for AccelByte.Api.Leaderboard:

Public Member Functions
void	GetRankings (string leaderboardCode, LeaderboardTimeFrame timeFrame, int offset, int limit, ResultCallback< LeaderboardRankingResult > callback)
	Get leaderboard ranking data from the beginning.
void	GetUserRanking (string userId, string leaderboardCode, ResultCallback< UserRankingData > callback)
	Get user's ranking from leaderboard.
void	GetUserRanking (string userId, string additionalKey, string leaderboardCode, ResultCallback< UserRankingData > callback)
	Get user's ranking from leaderboard with additional key. The additional key will be suffixed to the userId to access multi level user ranking, such as character ranking.
void	GetLeaderboardList (ResultCallback< LeaderboardPagedList > callback, int offset=0, int limit=0)
	List all leaderboard by given namespace.
void	GetLeaderboardListV3 (ResultCallback< LeaderboardPagedListV3 > callback, int offset=0, int limit=20)
	List all leaderboard by given namespace.
void	GetLeaderboardV3 (string leaderboardCode, ResultCallback< LeaderboardDataV3 > callback)
	Get leaderboard configuration by given leaderboard code.
void	GetRangkingsV3 (string leaderboardCode, ResultCallback< LeaderboardRankingResult > callback, int offset=0, int limit=20)
	Get leaderboard ranking data from the beginning.
void	GetRankingsV3 (string leaderboardCode, ResultCallback< LeaderboardRankingResult > callback, int offset=0, int limit=20)
	Get leaderboard ranking data from the beginning.
void	GetRankingsByCycle (string leaderboardCode, string cycleId, ResultCallback< LeaderboardRankingResult > callback, int offset=0, int limit=20)
	Get leaderboard's ranking list for specific cycle.
void	GetUserRankingV3 (string userId, string leaderboardCode, ResultCallback< UserRankingDataV3 > callback)
	Get user's ranking from leaderboard with additional key. The additional key will be suffixed to the userId to access multi level user ranking, such as character ranking.

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

Member Function Documentation

◆ GetLeaderboardList()

void AccelByte.Api.Leaderboard.GetLeaderboardList	(	ResultCallback< LeaderboardPagedList >	callback,
		int	offset = 0,
		int	limit = 0 )

inline

List all leaderboard by given namespace.

Parameters

callback	Returns a Result that contains LeaderboardPagedList via callback when completed
offset	Offset of the list that has been sliced based on Limit parameter (optional, default = 0)
limit	The limit of item on page (optional)

◆ GetLeaderboardListV3()

void AccelByte.Api.Leaderboard.GetLeaderboardListV3	(	ResultCallback< LeaderboardPagedListV3 >	callback,
		int	offset = 0,
		int	limit = 20 )

inline

List all leaderboard by given namespace.

Parameters

callback	Returns a Result that contains LeaderboardPagedListV3 via callback when completed
offset	Offset of the list that has been sliced based on Limit parameter (optional, default = 0)
limit	The limit of item on page (optional)

◆ GetLeaderboardV3()

void AccelByte.Api.Leaderboard.GetLeaderboardV3	(	string	leaderboardCode,
		ResultCallback< LeaderboardDataV3 >	callback )

inline

Get leaderboard configuration by given leaderboard code.

Parameters

callback	Returns a Result that contains leaderboard configuration
leaderboardCode

◆ GetRangkingsV3()

void AccelByte.Api.Leaderboard.GetRangkingsV3	(	string	leaderboardCode,
		ResultCallback< LeaderboardRankingResult >	callback,
		int	offset = 0,
		int	limit = 20 )

inline

Get leaderboard ranking data from the beginning.

Parameters

leaderboardCode	The id of the leaderboard
callback	Returns a Result that contains LeaderboardRankingResult via callback when completed
offset	Offset of the list that has been sliced based on Limit parameter (optional, default = 0)
limit	The limit of item on page (optional)

◆ GetRankings()

void AccelByte.Api.Leaderboard.GetRankings	(	string	leaderboardCode,
		LeaderboardTimeFrame	timeFrame,
		int	offset,
		int	limit,
		ResultCallback< LeaderboardRankingResult >	callback )

inline

Get leaderboard ranking data from the beginning.

Parameters

leaderboardCode	The id of the leaderboard
timeFrame	The time frame of leaderboard
offset	Offset of the list that has been sliced based on Limit parameter (optional, default = 0)
limit	The limit of item on page (optional)
callback	Returns a Result that contains LeaderboardRankingResult via callback when completed

◆ GetRankingsByCycle()

void AccelByte.Api.Leaderboard.GetRankingsByCycle	(	string	leaderboardCode,
		string	cycleId,
		ResultCallback< LeaderboardRankingResult >	callback,
		int	offset = 0,
		int	limit = 20 )

inline

Get leaderboard's ranking list for specific cycle.

Parameters

leaderboardCode	The id of the leaderboard
cycleId	The id of leaderboard cycle
callback	Returns a Result that contains LeaderboardRankingResult via callback when completed
offset	Offset of the list that has been sliced based on Limit parameter (optional, default = 0)
limit	The limit of item on page (optional)

◆ GetRankingsV3()

void AccelByte.Api.Leaderboard.GetRankingsV3	(	string	leaderboardCode,
		ResultCallback< LeaderboardRankingResult >	callback,
		int	offset = 0,
		int	limit = 20 )

inline

Get leaderboard ranking data from the beginning.

Parameters

leaderboardCode	The id of the leaderboard
callback	Returns a Result that contains LeaderboardRankingResult via callback when completed
offset	Offset of the list that has been sliced based on Limit parameter (optional, default = 0)
limit	The limit of item on page (optional)

◆ GetUserRanking() [1/2]

void AccelByte.Api.Leaderboard.GetUserRanking	(	string	userId,
		string	additionalKey,
		string	leaderboardCode,
		ResultCallback< UserRankingData >	callback )

inline

Get user's ranking from leaderboard with additional key. The additional key will be suffixed to the userId to access multi level user ranking, such as character ranking.

Parameters

userId	The id of the user
additionalKey	To identify multi level user ranking, such as character ranking
leaderboardCode	The id of the leaderboard
callback	Returns a Result that contains UserRankingData via callback when completed

◆ GetUserRanking() [2/2]

void AccelByte.Api.Leaderboard.GetUserRanking	(	string	userId,
		string	leaderboardCode,
		ResultCallback< UserRankingData >	callback )

inline

Get user's ranking from leaderboard.

Parameters

userId	The id of the user
leaderboardCode	The id of the leaderboard
callback	Returns a Result that contains UserRankingData via callback when completed

◆ GetUserRankingV3()

void AccelByte.Api.Leaderboard.GetUserRankingV3	(	string	userId,
		string	leaderboardCode,
		ResultCallback< UserRankingDataV3 >	callback )

inline

Get user's ranking from leaderboard with additional key. The additional key will be suffixed to the userId to access multi level user ranking, such as character ranking.

Parameters

userId	The id of the user
leaderboardCode	The id of the leaderboard
callback	Returns a Result that contains LeaderboardRankingResult via callback when completed

Public Member Functions

Additional Inherited Members

Member Function Documentation

◆ GetLeaderboardList()

◆ GetLeaderboardListV3()

◆ GetLeaderboardV3()

◆ GetRangkingsV3()

◆ GetRankings()

◆ GetRankingsByCycle()

◆ GetRankingsV3()

◆ GetUserRanking() [1/2]

◆ GetUserRanking() [2/2]

◆ GetUserRankingV3()