@globalleaderboards/sdk - v0.5.0
GitHub
API Documentation
GlobalLeaderboards.net
Preparing search index...
LeaderboardUpdateMessage
Interface LeaderboardUpdateMessage
Leaderboard update message with full state and mutations
interface
LeaderboardUpdateMessage
{
type
:
"leaderboard_update"
;
id
:
string
;
timestamp
:
string
;
payload
:
{
leaderboardId
:
string
;
updateType
:
"score_update"
|
"full_refresh"
|
"bulk_update"
;
leaderboard
:
{
entries
:
LeaderboardEntry
[]
;
totalEntries
:
number
;
displayedEntries
:
number
;
}
;
mutations
:
LeaderboardMutation
[]
;
trigger
:
UpdateTrigger
;
sequence
:
number
;
}
;
}
Hierarchy (
View Summary
)
WebSocketMessage
LeaderboardUpdateMessage
Index
Properties
type
id
timestamp
payload
Properties
type
type
:
"leaderboard_update"
id
id
:
string
timestamp
timestamp
:
string
payload
payload
:
{
leaderboardId
:
string
;
updateType
:
"score_update"
|
"full_refresh"
|
"bulk_update"
;
leaderboard
:
{
entries
:
LeaderboardEntry
[]
;
totalEntries
:
number
;
displayedEntries
:
number
;
}
;
mutations
:
LeaderboardMutation
[]
;
trigger
:
UpdateTrigger
;
sequence
:
number
;
}
Settings
Member Visibility
Protected
Inherited
External
Theme
OS
Light
Dark
On This Page
Properties
type
id
timestamp
payload
GitHub
API Documentation
GlobalLeaderboards.net
@globalleaderboards/sdk - v0.5.0
Loading...
Leaderboard update message with full state and mutations