Interface RankedEventPayloads

Centralized map linking each RankedEvent to its specific data structure. This is the core for type-safety when using client.on().

interface RankedEventPayloads {
    "draft.pickSuccess": PickSuccessPayload;
    "game.cancelled": GameCancelledPayload;
    "game.scored": GameScoredPayload;
    "game.scoreUndone": GameScoreUndonePayload;
    "game.started": GameStartedPayload;
    "game.startPick": GameStartPickPayload;
    "map.vote": MapVotedPayload;
    "mapban.banned": MapBannedPayload;
    "mapban.started": MapBanStartedPayload;
    "player.rankChanged": PlayerRankChangedPayload;
    "queue.joined": QueueJoinedPayload;
    "queue.kickFromQueue": KickFromQueuePayload;
    "queue.left": QueueLeftPayload;
    "season.started": SeasonStartedPayload;
    "user.banned": UserBannedPayload;
    "user.discordIdChanged": UserDiscordIdChangedPayload;
    "user.ignChanged": UserIGNChangedPayload;
    "user.registered": UserRegisteredPayload;
    "user.restored": UserRestoredPayload;
    "user.softDeleted": UserSoftDeletedPayload;
    "user.striked": UserStrikedPayload;
    "user.unbanned": UserUnbannedPayload;
    "user.unstriked": UserUnstrikedPayload;
}

Properties

draft.pickSuccess

"draft.pickSuccess": PickSuccessPayload

See

PickSuccessPayload

game.cancelled

"game.cancelled": GameCancelledPayload

See

GameCancelledPayload

game.scored

"game.scored": GameScoredPayload

See

GameScoredPayload

game.scoreUndone

"game.scoreUndone": GameScoreUndonePayload

See

GameScoreUndonePayload

game.started

"game.started": GameStartedPayload

See

GameStartedPayload

game.startPick

"game.startPick": GameStartPickPayload

See

GameStartPickPayload

map.vote

"map.vote": MapVotedPayload

See

MapVotedPayload

mapban.banned

"mapban.banned": MapBannedPayload

See

MapBannedPayload

mapban.started

"mapban.started": MapBanStartedPayload

See

MapBanStartedPayload

player.rankChanged

"player.rankChanged": PlayerRankChangedPayload

See

PlayerRankChangedPayload

queue.joined

"queue.joined": QueueJoinedPayload

See

QueueJoinedPayload

queue.kickFromQueue

"queue.kickFromQueue": KickFromQueuePayload

See

KickFromQueuePayload

queue.left

"queue.left": QueueLeftPayload

See

QueueLeftPayload

season.started

"season.started": SeasonStartedPayload

See

SeasonStartedPayload

user.banned

"user.banned": UserBannedPayload

See

UserBannedPayload

user.discordIdChanged

"user.discordIdChanged": UserDiscordIdChangedPayload

See

UserDiscordIdChangedPayload

user.ignChanged

"user.ignChanged": UserIGNChangedPayload

See

UserIGNChangedPayload

user.registered

"user.registered": UserRegisteredPayload

See

UserRegisteredPayload

user.restored

"user.restored": UserRestoredPayload

See

UserRestoredPayload

user.softDeleted

"user.softDeleted": UserSoftDeletedPayload

See

UserSoftDeletedPayload

user.striked

"user.striked": UserStrikedPayload

See

UserStrikedPayload

user.unbanned

"user.unbanned": UserUnbannedPayload

See

UserUnbannedPayload

user.unstriked

"user.unstriked": UserUnstrikedPayload

See

UserUnstrikedPayload