leaderboard | @livelike/engagementsdk - v2.53.0-alpha.0

API
Elements

Index

Functions

Functions

getLeaderboard

getLeaderboard(args: ILeaderboardArgs): Promise<ILeaderboardPayload>

Gets leaderboard detail from leaderboardId.
async
since
1.26.0

example
```
LiveLike.getLeaderboard({leaderboardId: string}).then(leaderboard => console.log(leaderboard))
```
Parameters
- args: ILeaderboardArgs
Returns Promise<ILeaderboardPayload>

getLeaderboardEntries

getLeaderboardEntries(args: ILeaderboardArgs): Promise<ILeaderboardEntries>

Parameters
- args: ILeaderboardArgs
Returns Promise<ILeaderboardEntries>

getLeaderboardProfileRank

getLeaderboardProfileRank(args: ILeaderboardRankArgs): Promise<ILeaderboardRankPayload>

Gets leaderboard entry for a given profile in a given leaderboard.
async
since
1.26.0

example
```
LiveLike.getLeaderboardProfileRank({leaderboardId: string, profileId: string}).then(leaderboardEntry => console.log(leaderboardEntry))
```
Parameters
- args: ILeaderboardRankArgs
Returns Promise<ILeaderboardRankPayload>

getLeaderboards

getLeaderboards(args: { programId: string }): Promise<ILeaderboardPayload[]>

Gets leaderboard list for a given program.
async
since
1.26.0

example
```
LiveLike.getLeaderboards({programId: string}).then(leaderboards => console.log(leaderboards))
```
Parameters
- args: { programId: string }
  - programId: string
Returns Promise<ILeaderboardPayload[]>

getPaginatedLeaderboardEntries

getPaginatedLeaderboardEntries(args: ILeaderboardArgs): Promise<AsyncIterator<Object, Function, Function>>

Gets leaderboard entries list from leaderboardId.
async
since
1.26.0

example
```
LiveLike.getLeaderboardEntries({programId: string}).then(response => console.log(response))
```
Parameters
- args: ILeaderboardArgs
Returns Promise<AsyncIterator<Object, Function, Function>>
Promise

getProfileLeaderboardViews

getProfileLeaderboardViews(args: IProfileLeaderboardArg): Promise<IPaginatedResponse<IProfileLeaderboardView>>

Get list of leaderboard views in which a given profile is part of. If no profileId is passed, get current profile leaderboard views
async
since
2.33.0

example
```
LiveLike.getProfileLeaderboardViews({profileId: "<profile-id>"})
.then(leaderboardviews => console.log(leaderboardviews))
```
Parameters
- args: IProfileLeaderboardArg
Returns Promise<IPaginatedResponse<IProfileLeaderboardView>>

getProfileLeaderboards

getProfileLeaderboards(args?: IProfileLeaderboardArg): Promise<IPaginatedResponse<IProfileLeaderboard>>

Get list of leaderboard in which a given profile is part of. If no profileId is passed, get current profile leaderboards
async
since
2.33.0

example
```
LiveLike.getProfileLeaderboards({profileId: "<profile-id>"})
.then(leaderboards => console.log(leaderboards))
```
Parameters
- Optional args: IProfileLeaderboardArg
Returns Promise<IPaginatedResponse<IProfileLeaderboard>>

Generated using TypeDoc