Class Leaderboard

Hierarchy (view full)

EventEmitter<LeaderboardEvents>
- Leaderboard

Index

Constructors

Properties

Methods

fetch fetchPlayerRating fetchPlayerRatingScoped fetchScoped off on once open openScoped publishRecord

Constructors

constructor

new Leaderboard(gp): Leaderboard
Parameters
- gp: CoreSDK
Returns Leaderboard
Overrides EventEmitter.constructor
- Defined in core/leaderboard/Leaderboard.ts:34

Properties

`Private` _events

_events: EventLite = ...

`Private` gp

Methods

fetch

fetch(searchQuery?): Promise<RatingData>
Parameters
- searchQuery: Omit<GetLeaderboardQuery, "playerId" | "displayFields"> = {}
Returns Promise<RatingData>
- Defined in core/leaderboard/Leaderboard.ts:70

fetchPlayerRating

fetchPlayerRating(searchQuery?): Promise<PlayerRatingData>
Parameters
- searchQuery: Omit<GetLeaderboardQuery, "displayFields" | "limit" | "withMe"> = {}
Returns Promise<PlayerRatingData>
- Defined in core/leaderboard/Leaderboard.ts:149

fetchPlayerRatingScoped

fetchPlayerRatingScoped(searchQuery): Promise<PlayerRatingData>
Parameters
- searchQuery: Omit<GetLeaderboardVariantQuery, "displayFields" | "withMe">
Returns Promise<PlayerRatingData>
- Defined in core/leaderboard/Leaderboard.ts:172

fetchScoped

fetchScoped(searchQuery): Promise<RatingData>
Parameters
- searchQuery: Omit<GetLeaderboardVariantQuery, "displayFields">
Returns Promise<RatingData>
- Defined in core/leaderboard/Leaderboard.ts:109

off

off<ET>(type, handler): void
Type Parameters
- ET extends keyof LeaderboardEvents
Parameters
- type: ET
- handler: ((event, ...args) => void)
  - - (event, ...args): void
    - Parameters
      event: LeaderboardEvents[ET]
      Rest ...args: any
      Returns void
Returns void
Inherited from EventEmitter.off
- Defined in core/events/EventEmitter.ts:12

on

on<ET>(type, handler): void
Type Parameters
- ET extends keyof LeaderboardEvents
Parameters
- type: ET
- handler: ((event, ...args) => void)
  - - (event, ...args): void
    - Parameters
      event: LeaderboardEvents[ET]
      Rest ...args: any
      Returns void
Returns void
Inherited from EventEmitter.on
- Defined in core/events/EventEmitter.ts:9

once

once<ET>(type, handler): void
Type Parameters
- ET extends keyof LeaderboardEvents
Parameters
- type: ET
- handler: ((event, ...args) => void)
  - - (event, ...args): void
    - Parameters
      event: LeaderboardEvents[ET]
      Rest ...args: any
      Returns void
Returns void
Inherited from EventEmitter.once
- Defined in core/events/EventEmitter.ts:15

open

open(searchQuery?): Promise<void>
Parameters
- searchQuery: GetLeaderboardQuery = ...
Returns Promise<void>
- Defined in core/leaderboard/Leaderboard.ts:39

openScoped

openScoped(searchQuery): Promise<void>
Parameters
- searchQuery: GetLeaderboardVariantQuery
Returns Promise<void>
- Defined in core/leaderboard/Leaderboard.ts:56

publishRecord

publishRecord(query): Promise<PlayerRecordData>
Parameters
- query: PublishRecordQuery
Returns Promise<PlayerRecordData>
- Defined in core/leaderboard/Leaderboard.ts:195