GatewayPlugin
The base class for all plugins
Extends
Extended by
Constructors
Constructor
new GatewayPlugin(
options
,gatewayInfo?
):GatewayPlugin
Parameters
Parameter | Type |
---|---|
options | GatewayPluginOptions |
gatewayInfo? | APIGatewayBotInfo |
Returns
GatewayPlugin
Overrides
Properties
Property | Modifier | Type | Default value | Description | Overrides |
---|---|---|---|---|---|
client? | protected | Client | undefined | - | - |
config | protected | GatewayPluginOptions | undefined | - | - |
emitter | protected | EventEmitter | undefined | - | - |
gatewayInfo? | protected | APIGatewayBotInfo | undefined | - | - |
heartbeatInterval? | public | Timeout | undefined | - | - |
id | protected | string | "gateway" | An ID that identifies the plugin uniquely between all other used plugins in the Client | Plugin .id |
lastHeartbeatAck | public | boolean | true | - | - |
monitor | protected | ConnectionMonitor | undefined | - | - |
sequence | public | null | number | null | - | - |
shardId? | public | number | undefined | - | - |
state | protected | GatewayState | undefined | - | - |
totalShards? | public | number | undefined | - | - |
ws | protected | null | WebSocket | null | - | - |
Methods
canResume()
protected
canResume():boolean
Returns
boolean
connect()
connect(
resume
):void
Parameters
Parameter | Type | Default value |
---|---|---|
resume | boolean | false |
Returns
void
createWebSocket()
protected
createWebSocket(url
):WebSocket
Parameters
Parameter | Type |
---|---|
url | string |
Returns
WebSocket
disconnect()
disconnect():
void
Returns
void
handleClose()
protected
handleClose(code
):void
Parameters
Parameter | Type |
---|---|
code | number |
Returns
void
handleReconnect()
protected
handleReconnect():void
Returns
void
handleReconnectionAttempt()
protected
handleReconnectionAttempt(options
):void
Parameters
Parameter | Type |
---|---|
options | { code : number ; forceNoResume : boolean ; isZombieConnection : boolean ; } |
options.code? | number |
options.forceNoResume? | boolean |
options.isZombieConnection? | boolean |
Returns
void
handleZombieConnection()
protected
handleZombieConnection():void
Returns
void
identify()
protected
identify():void
Returns
void
registerClient()
registerClient(
client
):Promise
<void
>
Registers the client with this plugin
Parameters
Parameter | Type | Description |
---|---|---|
client | Client | The client to register |
Returns
Promise
<void
>
Overrides
registerRoutes()?
optional
registerRoutes(client
):void
|Promise
<void
>
Registers the routes of this plugin with the client
Parameters
Parameter | Type | Description |
---|---|---|
client | Client | The client to register the routes with |
Returns
void
| Promise
<void
>
Inherited from
resume()
protected
resume():void
Returns
void
send()
send(
payload
):void
Parameters
Parameter | Type |
---|---|
payload | GatewayPayload |
Returns
void
setupWebSocket()
protected
setupWebSocket():void
Returns
void