Carbon
Plugins/Gateway/Classes

GatewayPlugin

The base class for all plugins

Extends

Extended by

Constructors

Constructor

new GatewayPlugin(options, gatewayInfo?): GatewayPlugin

Parameters

ParameterType
optionsGatewayPluginOptions
gatewayInfo?APIGatewayBotInfo

Returns

GatewayPlugin

Overrides

Plugin.constructor

Properties

PropertyModifierTypeDefault valueDescriptionOverrides
client?protectedClientundefined--
configprotectedGatewayPluginOptionsundefined--
emitterprotectedEventEmitterundefined--
gatewayInfo?protectedAPIGatewayBotInfoundefined--
heartbeatInterval?publicTimeoutundefined--
idprotectedstring"gateway"An ID that identifies the plugin uniquely between all other used plugins in the ClientPlugin.id
lastHeartbeatAckpublicbooleantrue--
monitorprotectedConnectionMonitorundefined--
sequencepublicnull | numbernull--
shardId?publicnumberundefined--
stateprotectedGatewayStateundefined--
totalShards?publicnumberundefined--
wsprotectednull | WebSocketnull--

Methods

canResume()

protected canResume(): boolean

Returns

boolean


connect()

connect(resume): void

Parameters

ParameterTypeDefault value
resumebooleanfalse

Returns

void


createWebSocket()

protected createWebSocket(url): WebSocket

Parameters

ParameterType
urlstring

Returns

WebSocket


disconnect()

disconnect(): void

Returns

void


handleClose()

protected handleClose(code): void

Parameters

ParameterType
codenumber

Returns

void


handleReconnect()

protected handleReconnect(): void

Returns

void


handleReconnectionAttempt()

protected handleReconnectionAttempt(options): void

Parameters

ParameterType
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

ParameterTypeDescription
clientClientThe client to register

Returns

Promise<void>

Overrides

Plugin.registerClient


registerRoutes()?

optional registerRoutes(client): void | Promise<void>

Registers the routes of this plugin with the client

Parameters

ParameterTypeDescription
clientClientThe client to register the routes with

Returns

void | Promise<void>

Inherited from

Plugin.registerRoutes


resume()

protected resume(): void

Returns

void


send()

send(payload): void

Parameters

ParameterType
payloadGatewayPayload

Returns

void


setupWebSocket()

protected setupWebSocket(): void

Returns

void

On this page