Search
Preparing search index...
The search index is not available
game-score-sdk
Options
All
Public
Public/Protected
All
Inherited
Externals
Menu
game-score-sdk
Leaderboard
Class Leaderboard
Hierarchy
EventEmitter
<
LeaderboardEvents
>
Leaderboard
Index
Constructors
constructor
Properties
_events
Methods
fetch
fetch
Player
Rating
fetch
Player
Rating
Scoped
fetch
Scoped
off
on
once
open
open
Scoped
publish
Record
Constructors
constructor
new
Leaderboard
(
gp
:
GamePush
)
:
Leaderboard
Parameters
gp:
GamePush
Returns
Leaderboard
Properties
Private
_events
_events
:
EventLite
= ...
Methods
fetch
fetch
(
searchQuery
?:
Omit
<
GetLeaderboardQuery
,
"playerId"
|
"displayFields"
>
)
:
Promise
<
RatingData
>
Parameters
searchQuery:
Omit
<
GetLeaderboardQuery
,
"playerId"
|
"displayFields"
>
= {}
Returns
Promise
<
RatingData
>
fetch
Player
Rating
fetch
Player
Rating
(
searchQuery
?:
Omit
<
GetLeaderboardQuery
,
"displayFields"
|
"limit"
|
"withMe"
>
)
:
Promise
<
PlayerRatingData
>
Parameters
searchQuery:
Omit
<
GetLeaderboardQuery
,
"displayFields"
|
"limit"
|
"withMe"
>
= {}
Returns
Promise
<
PlayerRatingData
>
fetch
Player
Rating
Scoped
fetch
Player
Rating
Scoped
(
searchQuery
:
Omit
<
GetLeaderboardVariantQuery
,
"displayFields"
|
"withMe"
>
)
:
Promise
<
PlayerRatingData
>
Parameters
searchQuery:
Omit
<
GetLeaderboardVariantQuery
,
"displayFields"
|
"withMe"
>
Returns
Promise
<
PlayerRatingData
>
fetch
Scoped
fetch
Scoped
(
searchQuery
:
Omit
<
GetLeaderboardVariantQuery
,
"displayFields"
>
)
:
Promise
<
RatingData
>
Parameters
searchQuery:
Omit
<
GetLeaderboardVariantQuery
,
"displayFields"
>
Returns
Promise
<
RatingData
>
off
off
<
ET
>
(
type
:
ET
, handler
:
(
(
event
:
LeaderboardEvents
[
ET
]
)
=>
void
)
)
:
void
Type Parameters
ET
extends
keyof
LeaderboardEvents
Parameters
type:
ET
handler:
(
(
event
:
LeaderboardEvents
[
ET
]
)
=>
void
)
(
event
:
LeaderboardEvents
[
ET
]
)
:
void
Parameters
event:
LeaderboardEvents
[
ET
]
Returns
void
Returns
void
on
on
<
ET
>
(
type
:
ET
, handler
:
(
(
event
:
LeaderboardEvents
[
ET
]
)
=>
void
)
)
:
void
Type Parameters
ET
extends
keyof
LeaderboardEvents
Parameters
type:
ET
handler:
(
(
event
:
LeaderboardEvents
[
ET
]
)
=>
void
)
(
event
:
LeaderboardEvents
[
ET
]
)
:
void
Parameters
event:
LeaderboardEvents
[
ET
]
Returns
void
Returns
void
once
once
<
ET
>
(
type
:
ET
, handler
:
(
(
event
:
LeaderboardEvents
[
ET
]
)
=>
void
)
)
:
void
Type Parameters
ET
extends
keyof
LeaderboardEvents
Parameters
type:
ET
handler:
(
(
event
:
LeaderboardEvents
[
ET
]
)
=>
void
)
(
event
:
LeaderboardEvents
[
ET
]
)
:
void
Parameters
event:
LeaderboardEvents
[
ET
]
Returns
void
Returns
void
open
open
(
searchQuery
?:
GetLeaderboardQuery
)
:
Promise
<
void
>
Parameters
searchQuery:
GetLeaderboardQuery
= ...
Returns
Promise
<
void
>
open
Scoped
open
Scoped
(
searchQuery
:
GetLeaderboardVariantQuery
)
:
Promise
<
void
>
Parameters
searchQuery:
GetLeaderboardVariantQuery
Returns
Promise
<
void
>
publish
Record
publish
Record
(
query
:
PublishRecordQuery
)
:
Promise
<
PlayerRecordData
>
Parameters
query:
PublishRecordQuery
Returns
Promise
<
PlayerRecordData
>
Exports
Leaderboard
constructor
_events
fetch
fetch
Player
Rating
fetch
Player
Rating
Scoped
fetch
Scoped
off
on
once
open
open
Scoped
publish
Record
Generated using
TypeDoc