hoshii / Exports / GatewayEventHandler
GatewayEventHandler
Represents a gateway event handler
Table of contents
Constructors
Properties
Methods
- ___addServerChannel
- __addServerChannel
- _addServerChannel
- botServerMembershipCreate
- botServerMembershipDelete
- calendarEventCreate
- calendarEventDelete
- calendarEventRSVPDelete
- calendarEventRSVPUpdate
- calendarEventUpdate
- channelMessageReactionCreate
- channelMessageReactionDelete
- chatMessageCreate
- chatMessageDelete
- chatMessageUpdate
- docCreate
- docDelete
- docUpdate
- forumTopicCommentCreate
- forumTopicCommentDelete
- forumTopicCommentReactionCreate
- forumTopicCommentReactionDelete
- forumTopicCommentUpdate
- forumTopicCreate
- forumTopicDelete
- forumTopicLock
- forumTopicPin
- forumTopicReactionCreate
- forumTopicReactionDelete
- forumTopicUnlock
- forumTopicUnpin
- forumTopicUpdate
- listItemComplete
- listItemCreate
- listItemDelete
- listItemUncomplete
- listItemUpdate
- serverChannelCreate
- serverChannelDelete
- serverChannelUpdate
- serverMemberBan
- serverMemberJoin
- serverMemberRemove
- serverMemberUnban
- serverMemberUpdate
- serverRolesUpdate
- serverWebhookCreate
- serverWebhookUpdate
Constructors
constructor
• new GatewayEventHandler(client)
Create a new gateway event handler
Parameters
| Name | Type | Description |
|---|---|---|
client | Client | The client |
Defined in
lib/gateway/GatewayEventHandler.ts:58
Properties
client
• client: Client
The client
Defined in
lib/gateway/GatewayEventHandler.ts:52
Methods
___addServerChannel
▸ Private ___addServerChannel(serverID, channelID, topicID?): Promise<void>
Parameters
| Name | Type |
|---|---|
serverID | string |
channelID | string |
topicID? | number |
Returns
Promise<void>
Defined in
lib/gateway/GatewayEventHandler.ts:62
__addServerChannel
▸ Private __addServerChannel(serverID, channelID, eventID?): Promise<void>
Parameters
| Name | Type |
|---|---|
serverID | string |
channelID | string |
eventID? | number |
Returns
Promise<void>
Defined in
lib/gateway/GatewayEventHandler.ts:90
_addServerChannel
▸ Private _addServerChannel(serverID, channelID): Promise<void>
Parameters
| Name | Type |
|---|---|
serverID | string |
channelID | string |
Returns
Promise<void>
Defined in
lib/gateway/GatewayEventHandler.ts:121
botServerMembershipCreate
▸ botServerMembershipCreate(data): void
Handle a BotServerMembershipCreated gateway event
Parameters
| Name | Type | Description |
|---|---|---|
data | Payload_BotServerMembershipCreated | The payload data |
Returns
void
Defined in
lib/gateway/GatewayEventHandler.ts:141
botServerMembershipDelete
▸ botServerMembershipDelete(data): void
Handle a BotServerMembershipDeleted gateway event
Parameters
| Name | Type | Description |
|---|---|---|
data | Payload_BotServerMembershipDeleted | The payload data |
Returns
void
Defined in
lib/gateway/GatewayEventHandler.ts:154
calendarEventCreate
▸ calendarEventCreate(data): void
Handle a BotServerMembershipUpdated gateway event
Parameters
| Name | Type | Description |
|---|---|---|
data | Payload_CalendarEvent | The payload data |
Returns
void
Defined in
lib/gateway/GatewayEventHandler.ts:167
calendarEventDelete
▸ calendarEventDelete(data): void
Handle a CalendarEventDeleted gateway event
Parameters
| Name | Type | Description |
|---|---|---|
data | Payload_CalendarEvent | The payload data |
Returns
void
Defined in
lib/gateway/GatewayEventHandler.ts:187
calendarEventRSVPDelete
▸ calendarEventRSVPDelete(data): void
Handle a CalendarEventRsvpDeleted gateway event
Parameters
| Name | Type | Description |
|---|---|---|
data | Payload_CalendarEventRSVP | The payload data |
Returns
void
Defined in
lib/gateway/GatewayEventHandler.ts:208
calendarEventRSVPUpdate
▸ calendarEventRSVPUpdate(data): void
Handle a CalendarEventRsvpUpdated gateway event
Parameters
| Name | Type | Description |
|---|---|---|
data | Payload_CalendarEventRSVP | The payload data |
Returns
void
Defined in
lib/gateway/GatewayEventHandler.ts:231
calendarEventUpdate
▸ calendarEventUpdate(data): void
Handle a CalendarEventUpdated gateway event
Parameters
| Name | Type | Description |
|---|---|---|
data | Payload_CalendarEvent | The payload data |
Returns
void
Defined in
lib/gateway/GatewayEventHandler.ts:254
channelMessageReactionCreate
▸ channelMessageReactionCreate(data): void
Handle a ChannelMessageReactionCreated gateway event
Parameters
| Name | Type | Description |
|---|---|---|
data | Payload_ChannelMessageReaction | The payload data |
Returns
void
Defined in
lib/gateway/GatewayEventHandler.ts:274
channelMessageReactionDelete
▸ channelMessageReactionDelete(data): void
Handle a ChannelMessageReactionDeleted gateway event
Parameters
| Name | Type | Description |
|---|---|---|
data | Payload_ChannelMessageReaction | The payload data |
Returns
void
Defined in
lib/gateway/GatewayEventHandler.ts:288
chatMessageCreate
▸ chatMessageCreate(data): void
Handle a ChatMessageCreated gateway event
Parameters
| Name | Type | Description |
|---|---|---|
data | Payload_ChatMessage | The payload data |
Returns
void
Defined in
lib/gateway/GatewayEventHandler.ts:302
chatMessageDelete
▸ chatMessageDelete(data): void
Handle a ChatMessageDeleted gateway event
Parameters
| Name | Type | Description |
|---|---|---|
data | Payload_ChatMessageDeleted | The payload data |
Returns
void
Defined in
lib/gateway/GatewayEventHandler.ts:318
chatMessageUpdate
▸ chatMessageUpdate(data): void
Handle a ChatMessageUpdated gateway event
Parameters
| Name | Type | Description |
|---|---|---|
data | Payload_ChatMessage | The payload data |
Returns
void
Defined in
lib/gateway/GatewayEventHandler.ts:341
docCreate
▸ docCreate(data): void
Handle a DocCreated gateway event
Parameters
| Name | Type | Description |
|---|---|---|
data | Payload_Doc | The payload data |
Returns
void
Defined in
lib/gateway/GatewayEventHandler.ts:357
docDelete
▸ docDelete(data): void
Handle a DocDeleted gateway event
Parameters
| Name | Type | Description |
|---|---|---|
data | Payload_Doc | The payload data |
Returns
void
Defined in
lib/gateway/GatewayEventHandler.ts:373
docUpdate
▸ docUpdate(data): void
Handle a DocUpdated gateway event
Parameters
| Name | Type | Description |
|---|---|---|
data | Payload_Doc | The payload data |
Returns
void
Defined in
lib/gateway/GatewayEventHandler.ts:391
forumTopicCommentCreate
▸ forumTopicCommentCreate(data): void
Handle a ForumTopicCommentCreated gateway event
Parameters
| Name | Type | Description |
|---|---|---|
data | Payload_ForumTopicComment | The payload data |
Returns
void
Defined in
lib/gateway/GatewayEventHandler.ts:407
forumTopicCommentDelete
▸ forumTopicCommentDelete(data): void
Handle a ForumTopicCommentDeleted gateway event
Parameters
| Name | Type | Description |
|---|---|---|
data | Payload_ForumTopicComment | The payload data |
Returns
void
Defined in
lib/gateway/GatewayEventHandler.ts:433
forumTopicCommentReactionCreate
▸ forumTopicCommentReactionCreate(data): void
Handle a ForumTopicCommentReactionCreated gateway event1
Parameters
| Name | Type | Description |
|---|---|---|
data | Payload_ForumTopicCommentReaction | The payload data |
Returns
void
Defined in
lib/gateway/GatewayEventHandler.ts:459
forumTopicCommentReactionDelete
▸ forumTopicCommentReactionDelete(data): void
Handle a ForumTopicCommentReactionDeleted gateway event
Parameters
| Name | Type | Description |
|---|---|---|
data | Payload_ForumTopicCommentReaction | The payload data |
Returns
void
Defined in
lib/gateway/GatewayEventHandler.ts:476
forumTopicCommentUpdate
▸ forumTopicCommentUpdate(data): void
Handle a ForumTopicCommentUpdated gateway event
Parameters
| Name | Type | Description |
|---|---|---|
data | Payload_ForumTopicComment | The payload data |
Returns
void
Defined in
lib/gateway/GatewayEventHandler.ts:493
forumTopicCreate
▸ forumTopicCreate(data): void
Handle a ForumTopicCreated gateway event
Parameters
| Name | Type | Description |
|---|---|---|
data | Payload_ForumTopic | The payload data |
Returns
void
Defined in
lib/gateway/GatewayEventHandler.ts:516
forumTopicDelete
▸ forumTopicDelete(data): void
Handle a ForumTopicDeleted gateway event
Parameters
| Name | Type | Description |
|---|---|---|
data | Payload_ForumTopic | The payload data |
Returns
void
Defined in
lib/gateway/GatewayEventHandler.ts:534
forumTopicLock
▸ forumTopicLock(data): void
Handle a ForumTopicLocked gateway event
Parameters
| Name | Type | Description |
|---|---|---|
data | Payload_ForumTopic | The payload data |
Returns
void
Defined in
lib/gateway/GatewayEventHandler.ts:552
forumTopicPin
▸ forumTopicPin(data): void
Handle a ForumTopicPinned gateway event
Parameters
| Name | Type | Description |
|---|---|---|
data | Payload_ForumTopic | The payload data |
Returns
void
Defined in
lib/gateway/GatewayEventHandler.ts:569
forumTopicReactionCreate
▸ forumTopicReactionCreate(data): void
Handle a ForumTopicReactionCreated gateway event
Parameters
| Name | Type | Description |
|---|---|---|
data | Payload_ForumTopicReaction | The payload data |
Returns
void
Defined in
lib/gateway/GatewayEventHandler.ts:586
forumTopicReactionDelete
▸ forumTopicReactionDelete(data): void
Handle a ForumTopicReactionDeleted gateway event
Parameters
| Name | Type | Description |
|---|---|---|
data | Payload_ForumTopicReaction | The payload data |
Returns
void
Defined in
lib/gateway/GatewayEventHandler.ts:601
forumTopicUnlock
▸ forumTopicUnlock(data): void
Handle a ForumTopicUnlocked gateway event
Parameters
| Name | Type | Description |
|---|---|---|
data | Payload_ForumTopic | The payload data |
Returns
void
Defined in
lib/gateway/GatewayEventHandler.ts:616
forumTopicUnpin
▸ forumTopicUnpin(data): void
Handle a ForumTopicUnpinned gateway event
Parameters
| Name | Type | Description |
|---|---|---|
data | Payload_ForumTopic | The payload data |
Returns
void
Defined in
lib/gateway/GatewayEventHandler.ts:633
forumTopicUpdate
▸ forumTopicUpdate(data): void
Handle a ForumTopicUpdated gateway event
Parameters
| Name | Type | Description |
|---|---|---|
data | Payload_ForumTopic | The payload data |
Returns
void
Defined in
lib/gateway/GatewayEventHandler.ts:650
listItemComplete
▸ listItemComplete(data): void
Handle a ListItemCompleted gateway event
Parameters
| Name | Type | Description |
|---|---|---|
data | Payload_ListItem | The payload data |
Returns
void
Defined in
lib/gateway/GatewayEventHandler.ts:667
listItemCreate
▸ listItemCreate(data): void
Handle a ListItemCreated gateway event
Parameters
| Name | Type | Description |
|---|---|---|
data | Payload_ListItem | The payload data |
Returns
void
Defined in
lib/gateway/GatewayEventHandler.ts:677
listItemDelete
▸ listItemDelete(data): void
Handle a ListItemDeleted gateway event
Parameters
| Name | Type | Description |
|---|---|---|
data | Payload_ListItem | The payload data |
Returns
void
Defined in
lib/gateway/GatewayEventHandler.ts:687
listItemUncomplete
▸ listItemUncomplete(data): void
Handle a ListItemUncompleted gateway event
Parameters
| Name | Type | Description |
|---|---|---|
data | Payload_ListItem | The payload data |
Returns
void
Defined in
lib/gateway/GatewayEventHandler.ts:697
listItemUpdate
▸ listItemUpdate(data): void
Handle a ListItemUpdated gateway event
Parameters
| Name | Type | Description |
|---|---|---|
data | Payload_ListItem | The payload data |
Returns
void
Defined in
lib/gateway/GatewayEventHandler.ts:707
serverChannelCreate
▸ serverChannelCreate(data): void
Handle a ServerChannelCreated gateway event
Parameters
| Name | Type | Description |
|---|---|---|
data | Payload_ServerChannel | The payload data |
Returns
void
Defined in
lib/gateway/GatewayEventHandler.ts:717
serverChannelDelete
▸ serverChannelDelete(data): void
Handle a ServerChannelDeleted gateway event
Parameters
| Name | Type | Description |
|---|---|---|
data | Payload_ServerChannel | The payload data |
Returns
void
Defined in
lib/gateway/GatewayEventHandler.ts:729
serverChannelUpdate
▸ serverChannelUpdate(data): void
Handle a ServerChannelUpdated gateway event
Parameters
| Name | Type | Description |
|---|---|---|
data | Payload_ServerChannel | The payload data |
Returns
void
Defined in
lib/gateway/GatewayEventHandler.ts:741
serverMemberBan
▸ serverMemberBan(data): void
Handle a ServerMemberBanned gateway event
Parameters
| Name | Type | Description |
|---|---|---|
data | Payload_ServerMemberBan | The payload data |
Returns
void
Defined in
lib/gateway/GatewayEventHandler.ts:753
serverMemberJoin
▸ serverMemberJoin(data): void
Handle a ServerMemberJoined gateway event
Parameters
| Name | Type | Description |
|---|---|---|
data | Payload_ServerMemberJoined | The payload data |
Returns
void
Defined in
lib/gateway/GatewayEventHandler.ts:767
serverMemberRemove
▸ serverMemberRemove(data): void
Handle a ServerMemberRemoved gateway event
Parameters
| Name | Type | Description |
|---|---|---|
data | Payload_ServerMemberRemoved | The payload data |
Returns
void
Defined in
lib/gateway/GatewayEventHandler.ts:781
serverMemberUnban
▸ serverMemberUnban(data): void
Handle a ServerMemberUnbanned gateway event
Parameters
| Name | Type | Description |
|---|---|---|
data | Payload_ServerMemberBan | The payload data |
Returns
void
Defined in
lib/gateway/GatewayEventHandler.ts:795
serverMemberUpdate
▸ serverMemberUpdate(data): void
Handle a ServerMemberUpdated gateway event
Parameters
| Name | Type | Description |
|---|---|---|
data | Payload_ServerMemberUpdated | The payload data |
Returns
void
Defined in
lib/gateway/GatewayEventHandler.ts:809
serverRolesUpdate
▸ serverRolesUpdate(data): void
Handle a ServerRolesUpdated gateway event
Parameters
| Name | Type | Description |
|---|---|---|
data | Payload_ServerRolesUpdated | The payload data |
Returns
void
Defined in
lib/gateway/GatewayEventHandler.ts:823
serverWebhookCreate
▸ serverWebhookCreate(data): void
Handle a ServerWebhookCreated gateway event
Parameters
| Name | Type | Description |
|---|---|---|
data | Payload_ServerWebhook | The payload data |
Returns
void
Defined in
lib/gateway/GatewayEventHandler.ts:837
serverWebhookUpdate
▸ serverWebhookUpdate(data): void
Handle a ServerWebhookUpdated gateway event
Parameters
| Name | Type | Description |
|---|---|---|
data | Payload_ServerWebhook | The payload data |
Returns
void