Index
Functions
Const get Leaderboard
Parameters
args: ILeaderboardArgs
Returns Promise<ILeaderboardPayload>
Const get Leaderboard Entries
Parameters
args: ILeaderboardArgs
Returns Promise<ILeaderboardEntries>
Const get Leaderboard Profile Rank
Gets leaderboard entry for a given profile in a given leaderboard.
Parameters
args: ILeaderboardRankArgs
Returns Promise<ILeaderboardRankPayload>
Const get Leaderboards
Gets leaderboard list for a given program.
Parameters
args: { programId: string }
program
Id: string
Returns Promise<ILeaderboardPayload[]>
Const get Paginated Leaderboard Entries
Gets leaderboard entries list from leaderboardId.
Parameters
args: ILeaderboardArgs
Returns Promise<AsyncIterator<Object, Function, Function>>
Promise
Const get Profile Leaderboard Views
Get list of leaderboard views in which a given profile is part of. If no profileId is passed, get current profile leaderboard views
Parameters
args: IProfileLeaderboardArg
Returns Promise<IPaginatedResponse<IProfileLeaderboardView>>
Const get Profile Leaderboards
Get list of leaderboard in which a given profile is part of. If no profileId is passed, get current profile leaderboards
Parameters
Optional args: IProfileLeaderboardArg
Returns Promise<IPaginatedResponse<IProfileLeaderboard>>
Generated using TypeDoc
Gets leaderboard detail from leaderboardId.
1.26.0