Inheritance diagram for Beamable.Common.Api.Leaderboards.ILeaderboardApi:

[legend]

Public Member Functions
UserDataCache< RankEntry >	GetCache (string boardId)
	Get the UserDataCache<RankEntry> with RankEntry values for some leaderboard ID. More...

Promise< LeaderboardAssignmentInfo >	GetAssignment (string boardId, bool joinBoard)
	For partitioned or cohorted leaderboards Resolves the specific child leaderboard the player is assigned to e.g. "leaderboards.my_partitioned_board" -> "leaderboards.my_partitioned_board#0" – where #0 denotes the partition identifier More...

Promise< LeaderboardAssignmentInfo >	ResolveAssignment (string boardId, long gamerTag)
	For partitioned or cohorted leaderboards Resolves the specific child leaderboard the player is assigned to Uses a cache to avoid repeat communication with the server More...

Promise< RankEntry >	GetUser (LeaderboardRef leaderBoard, long gamerTag)
	Get the rank of a specific player on a specific leaderboard More...

Promise< RankEntry >	GetUser (string boardId, long gamerTag)
	Get the rank of a specific player on a specific leaderboard More...

Promise< LeaderBoardView >	GetBoard (LeaderboardRef leaderBoard, int from, int max, long? focus=null, long? outlier=null)
	Get a view with ranking of a specific leaderboard More...

Promise< LeaderBoardView >	GetBoard (string boardId, int from, int max, long? focus=null, long? outlier=null)
	Get a view with ranking of a specific leaderboard More...

Promise< LeaderBoardView >	GetAssignedBoard (LeaderboardRef leaderBoard, int from, int max, long? focus=null, long? outlier=null)
	For partitioned or cohorted leaderboards Get a view with rankings of child leaderboard the current player is assigned to More...

Promise< LeaderBoardView >	GetAssignedBoard (string boardId, int from, int max, long? focus=null, long? outlier=null)
	For partitioned or cohorted leaderboards Get a view with rankings of child leaderboard the current player is assigned to More...

Promise< LeaderBoardView >	GetRanks (LeaderboardRef leaderBoard, List< long > ids)
	Get a specific list of rankings by player id/gamertag from a leaderboard More...

Promise< LeaderBoardView >	GetRanks (string boardId, List< long > ids)
	Get a specific list of rankings by player id/gamertag from a leaderboard More...

Promise< EmptyResponse >	SetScore (LeaderboardRef leaderBoard, double score, IDictionary< string, object > stats=null)
	Replace the score of the current player Cohorted and Partitioned leaderboards will automatically update the correct child leaderboard More...

Promise< EmptyResponse >	SetScore (string boardId, double score, IDictionary< string, object > stats=null)
	Replace the score of the current player Cohorted and Partitioned leaderboards will automatically update the correct child leaderboard More...

Promise< EmptyResponse >	IncrementScore (LeaderboardRef leaderBoard, double score, IDictionary< string, object > stats=null)
	Increment (add to) the score of the current player Cohorted and Partitioned leaderboards will automatically update the correct child leaderboard More...

Promise< EmptyResponse >	IncrementScore (string boardId, double score, IDictionary< string, object > stats=null)
	Increment (add to) the score of the current player Cohorted and Partitioned leaderboards will automatically update the correct child leaderboard More...

Promise< LeaderBoardView >	GetFriendRanks (LeaderboardRef leaderboard)
	Get the rankings of the current player's friends participating in this leaderboard More...

Promise< LeaderBoardView >	GetFriendRanks (string boardId)
	Get the rankings of the current player's friends participating in this leaderboard More...

Member Function Documentation

◆ GetAssignedBoard() [1/2]

Promise< LeaderBoardView > Beamable.Common.Api.Leaderboards.ILeaderboardApi.GetAssignedBoard	(	LeaderboardRef	leaderBoard,
		int	from,
		int	max,
		long?	focus = `null`,
		long?	outlier = `null`
	)

For partitioned or cohorted leaderboards Get a view with rankings of child leaderboard the current player is assigned to

Parameters

leaderBoard
from
max
focus
outlier

Returns

◆ GetAssignedBoard() [2/2]

Promise< LeaderBoardView > Beamable.Common.Api.Leaderboards.ILeaderboardApi.GetAssignedBoard	(	string	boardId,
		int	from,
		int	max,
		long?	focus = `null`,
		long?	outlier = `null`
	)

For partitioned or cohorted leaderboards Get a view with rankings of child leaderboard the current player is assigned to

Parameters

boardId
from
max
focus
outlier

Returns

◆ GetAssignment()

Promise< LeaderboardAssignmentInfo > Beamable.Common.Api.Leaderboards.ILeaderboardApi.GetAssignment	(	string	boardId,
		bool	joinBoard
	)

For partitioned or cohorted leaderboards Resolves the specific child leaderboard the player is assigned to e.g. "leaderboards.my_partitioned_board" -> "leaderboards.my_partitioned_board#0" – where #0 denotes the partition identifier

Parameters

boardId	Parent Leaderboard Id
joinBoard	Join the board if the player is not assigned.

Returns

Implemented in Beamable.Common.Api.Leaderboards.LeaderboardApi.

◆ GetBoard() [1/2]

Promise< LeaderBoardView > Beamable.Common.Api.Leaderboards.ILeaderboardApi.GetBoard	(	LeaderboardRef	leaderBoard,
		int	from,
		int	max,
		long?	focus = `null`,
		long?	outlier = `null`
	)

Get a view with ranking of a specific leaderboard

Parameters

leaderBoard
from
max
focus
outlier

Returns

◆ GetBoard() [2/2]

Promise< LeaderBoardView > Beamable.Common.Api.Leaderboards.ILeaderboardApi.GetBoard	(	string	boardId,
		int	from,
		int	max,
		long?	focus = `null`,
		long?	outlier = `null`
	)

Get a view with ranking of a specific leaderboard

Parameters

boardId
from
max
focus
outlier

Returns

◆ GetCache()

UserDataCache< RankEntry > Beamable.Common.Api.Leaderboards.ILeaderboardApi.GetCache ( string boardId )

Get the UserDataCache<RankEntry> with RankEntry values for some leaderboard ID.

Parameters

boardId The leaderboard ID

Returns: A UserDataCache<T> of RankEntry

Implemented in Beamable.Common.Api.Leaderboards.LeaderboardApi.

◆ GetFriendRanks() [1/2]

Promise< LeaderBoardView > Beamable.Common.Api.Leaderboards.ILeaderboardApi.GetFriendRanks ( LeaderboardRef leaderboard )

Get the rankings of the current player's friends participating in this leaderboard

Parameters

leaderboard

Returns

Implemented in Beamable.Common.Api.Leaderboards.LeaderboardApi.

◆ GetFriendRanks() [2/2]

Promise< LeaderBoardView > Beamable.Common.Api.Leaderboards.ILeaderboardApi.GetFriendRanks ( string boardId )

Get the rankings of the current player's friends participating in this leaderboard

Parameters

boardId

Returns

Implemented in Beamable.Common.Api.Leaderboards.LeaderboardApi.

◆ GetRanks() [1/2]

Promise< LeaderBoardView > Beamable.Common.Api.Leaderboards.ILeaderboardApi.GetRanks	(	LeaderboardRef	leaderBoard,
		List< long >	ids
	)

Get a specific list of rankings by player id/gamertag from a leaderboard

Parameters

leaderBoard
ids

Returns

Implemented in Beamable.Common.Api.Leaderboards.LeaderboardApi.

◆ GetRanks() [2/2]

Promise< LeaderBoardView > Beamable.Common.Api.Leaderboards.ILeaderboardApi.GetRanks	(	string	boardId,
		List< long >	ids
	)

Get a specific list of rankings by player id/gamertag from a leaderboard

Parameters

boardId
ids

Returns

Implemented in Beamable.Common.Api.Leaderboards.LeaderboardApi.

◆ GetUser() [1/2]

Promise< RankEntry > Beamable.Common.Api.Leaderboards.ILeaderboardApi.GetUser	(	LeaderboardRef	leaderBoard,
		long	gamerTag
	)

Get the rank of a specific player on a specific leaderboard

Parameters

leaderBoard
gamerTag

Returns

Implemented in Beamable.Common.Api.Leaderboards.LeaderboardApi.

◆ GetUser() [2/2]

Promise< RankEntry > Beamable.Common.Api.Leaderboards.ILeaderboardApi.GetUser	(	string	boardId,
		long	gamerTag
	)

Get the rank of a specific player on a specific leaderboard

Parameters

boardId
gamerTag

Returns

Implemented in Beamable.Common.Api.Leaderboards.LeaderboardApi.

◆ IncrementScore() [1/2]

Promise< EmptyResponse > Beamable.Common.Api.Leaderboards.ILeaderboardApi.IncrementScore	(	LeaderboardRef	leaderBoard,
		double	score,
		IDictionary< string, object >	stats = `null`
	)

Increment (add to) the score of the current player Cohorted and Partitioned leaderboards will automatically update the correct child leaderboard

Parameters

leaderBoard
score
stats

Returns

Implemented in Beamable.Common.Api.Leaderboards.LeaderboardApi.

◆ IncrementScore() [2/2]

Promise< EmptyResponse > Beamable.Common.Api.Leaderboards.ILeaderboardApi.IncrementScore	(	string	boardId,
		double	score,
		IDictionary< string, object >	stats = `null`
	)

Increment (add to) the score of the current player Cohorted and Partitioned leaderboards will automatically update the correct child leaderboard

Parameters

boardId
score
stats

Returns

Implemented in Beamable.Common.Api.Leaderboards.LeaderboardApi.

◆ ResolveAssignment()

Promise< LeaderboardAssignmentInfo > Beamable.Common.Api.Leaderboards.ILeaderboardApi.ResolveAssignment	(	string	boardId,
		long	gamerTag
	)

For partitioned or cohorted leaderboards Resolves the specific child leaderboard the player is assigned to Uses a cache to avoid repeat communication with the server

Parameters

boardId
gamerTag

Returns

Implemented in Beamable.Common.Api.Leaderboards.LeaderboardApi.

◆ SetScore() [1/2]

Promise< EmptyResponse > Beamable.Common.Api.Leaderboards.ILeaderboardApi.SetScore	(	LeaderboardRef	leaderBoard,
		double	score,
		IDictionary< string, object >	stats = `null`
	)

Replace the score of the current player Cohorted and Partitioned leaderboards will automatically update the correct child leaderboard

Parameters

leaderBoard
score
stats

Returns

Implemented in Beamable.Common.Api.Leaderboards.LeaderboardApi.

◆ SetScore() [2/2]

Promise< EmptyResponse > Beamable.Common.Api.Leaderboards.ILeaderboardApi.SetScore	(	string	boardId,
		double	score,
		IDictionary< string, object >	stats = `null`
	)

Replace the score of the current player Cohorted and Partitioned leaderboards will automatically update the correct child leaderboard

Parameters

boardId
score
stats

Returns

Implemented in Beamable.Common.Api.Leaderboards.LeaderboardApi.

The documentation for this interface was generated from the following file:

com.beamable/Common/Runtime/Api/Leaderboards/ILeaderboardApi.cs

Public Member Functions

Member Function Documentation

◆ GetAssignedBoard() [1/2]

◆ GetAssignedBoard() [2/2]

◆ GetAssignment()

◆ GetBoard() [1/2]

◆ GetBoard() [2/2]

◆ GetCache()

◆ GetFriendRanks() [1/2]

◆ GetFriendRanks() [2/2]

◆ GetRanks() [1/2]

◆ GetRanks() [2/2]

◆ GetUser() [1/2]

◆ GetUser() [2/2]

◆ IncrementScore() [1/2]

◆ IncrementScore() [2/2]

◆ ResolveAssignment()

◆ SetScore() [1/2]

◆ SetScore() [2/2]