Module "scripts/leaderboard"

Index

Functions

Functions

Const getLeaderboard

getLeaderboard(args: ILeaderboardArgs): Promise<ILeaderboardPayload>

- Defined in src/scripts/leaderboard.ts:50
Gets leaderboard detail from leaderboardId. Returns Promise that resolve leaderboard.
async

throws

{Error}

since

1.26.0

example
```
LiveLike.getLeaderboard({leaderboardId: '70bf764a-dce4-4c17-9529-a305c3b404f3'}).then(leaderboard => console.log(leaderboard))
```
Parameters
- args: ILeaderboardArgs
Returns Promise<ILeaderboardPayload>

Leaderboard object

Const getLeaderboardEntries

getLeaderboardEntries(args: ILeaderboardEntriesArgs): Promise<ILeaderboardEntries>

- Defined in src/scripts/leaderboard.ts:70
Gets leaderboard entries list from leaderboardId. Returns Promise that resolve list of leaderboards.
async

throws

{Error}

since

1.26.0

example
```
LiveLike.getLeaderboardEntries({programId: '6834f1fd-f24d-4538-ba51-63544f9d78eb', page: 'first'}).then(response => console.log(response))
```
Parameters
- args: ILeaderboardEntriesArgs
Returns Promise<ILeaderboardEntries>

Object containing list of leaderboard entries, total count of leaderboard entries and pagination info

Const getLeaderboardProfileRank

getLeaderboardProfileRank(args: ILeaderboardRankArgs): Promise<ILeaderboardRankPayload>

- Defined in src/scripts/leaderboard.ts:140
Gets leaderboard entry for a given profile in a given leaderboard. Returns Promise that resolve leaderboard entry.
async

throws

{Error}

since

1.26.0

example
```
LiveLike.getLeaderboardProfileRank({leaderboardId: '70bf764a-dce4-4c17-9529-a305c3b404f3', profileId:'5429272d-4ba9-42e9-b26e-0cd13c138546'}).then(leaderboardEntry => console.log(leaderboardEntry))
```
Parameters
- args: ILeaderboardRankArgs
Returns Promise<ILeaderboardRankPayload>

Leaderboard Entry object

Const getLeaderboards

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

- Defined in src/scripts/leaderboard.ts:30
Gets leaderboard list for a given program. Returns Promise that resolve list of leaderboards.
async

throws

{Error}

since

1.26.0

example
```
LiveLike.getLeaderboards({programId: '6834f1fd-f24d-4538-ba51-63544f9d78eb'}).then(leaderboards => console.log(leaderboards))
```
Parameters
- args: { programId: string }
  - programId: string
Returns Promise<ILeaderboardPayload[]>

Leaderboard object

Generated using TypeDoc