Class BotConnection

Responsible for the creation and closure of the WebSocket connection to the Discord API gateway

Hierarchy

BotConnection

Index

Constructors

constructor

Methods

Constructors

constructor

new BotConnection(bot: Bot, token: string): BotConnection

- Defined in src/bot/BotConnection.ts:13
Parameters
- bot: Bot
- token: string
Returns BotConnection

Methods

connect

connect(): Promise<void>

- Defined in src/bot/BotConnection.ts:23
Creates a new bot connection

Returns Promise<void>

disconnect

disconnect(code?: GatewayCloseCode): void

- Defined in src/bot/BotConnection.ts:31
Closes the currently running connection

Parameters
- Default value code: GatewayCloseCode = GatewayCloseCode.ManualClosure
  
  WebSocket close code
Returns void

disconnectAll

disconnectAll(code?: GatewayCloseCode): void

- Defined in src/bot/BotConnection.ts:39
Closes all currently running connections for all shards

Parameters
- Default value code: GatewayCloseCode = GatewayCloseCode.ManualClosure
  
  WebSocket close code
Returns void

modifyPresence

modifyPresence(presence: GatewayStruct): void

- Defined in src/bot/BotConnection.ts:56
Modifies the presence of the bot

Parameters
- presence: GatewayStruct
  
  The new presence for the bot
Returns void

Generated using TypeDoc