Skip to main content

@slack/socket-mode / SocketModeClient

Class: SocketModeClient

Defined in: src/SocketModeClient.ts:36

A Socket Mode Client allows programs to communicate with the Slack Platform's Events API over WebSocket connections. This object uses the EventEmitter pattern to dispatch incoming events and has a built in send method to acknowledge incoming events over the WebSocket connection.

Extends​

  • EventEmitter

Constructors​

Constructor​

new SocketModeClient(__namedParameters): SocketModeClient;

Defined in: src/SocketModeClient.ts:96

Parameters​

__namedParameters​

SocketModeOptions = ...

Returns​

SocketModeClient

Overrides​

EventEmitter.constructor

Properties​

websocket?​

optional websocket: SlackWebSocket;

Defined in: src/SocketModeClient.ts:66

The underlying WebSocket client instance

prefixed​

static prefixed: string | boolean;

Defined in: node_modules/eventemitter3/index.d.ts:9

Inherited from​

EventEmitter.prefixed

Methods​

addListener()​

addListener<T>(
   event, 
   fn, 
   context?): this;

Defined in: node_modules/eventemitter3/index.d.ts:45

Type Parameters​

T​

T extends string | symbol

Parameters​

event​

T

fn​

(...args) => void

context?​

any

Returns​

this

Inherited from​

EventEmitter.addListener

disconnect()​

disconnect(): Promise<void>;

Defined in: src/SocketModeClient.ts:205

End a Socket Mode session. After this method is called no messages will be sent or received unless you call start() again later.

Returns​

Promise<void>

emit()​

emit<T>(event, ...args): boolean;

Defined in: node_modules/eventemitter3/index.d.ts:32

Calls each of the listeners registered for a given event.

Type Parameters​

T​

T extends string | symbol

Parameters​

event​

T

args​

...any[]

Returns​

boolean

Inherited from​

EventEmitter.emit

eventNames()​

eventNames(): (string | symbol)[];

Defined in: node_modules/eventemitter3/index.d.ts:15

Return an array listing the events for which the emitter has registered listeners.

Returns​

(string | symbol)[]

Inherited from​

EventEmitter.eventNames

listenerCount()​

listenerCount(event): number;

Defined in: node_modules/eventemitter3/index.d.ts:27

Return the number of listeners listening to a given event.

Parameters​

event​

string | symbol

Returns​

number

Inherited from​

EventEmitter.listenerCount

listeners()​

listeners<T>(event): (...args) => void[];

Defined in: node_modules/eventemitter3/index.d.ts:20

Return the listeners registered for a given event.

Type Parameters​

T​

T extends string | symbol

Parameters​

event​

T

Returns​

(...args) => void[]

Inherited from​

EventEmitter.listeners

off()​

off<T>(
   event, 
   fn?, 
   context?, 
   once?): this;

Defined in: node_modules/eventemitter3/index.d.ts:69

Type Parameters​

T​

T extends string | symbol

Parameters​

event​

T

fn?​

(...args) => void

context?​

any

once?​

boolean

Returns​

this

Inherited from​

EventEmitter.off

on()​

on<T>(
   event, 
   fn, 
   context?): this;

Defined in: node_modules/eventemitter3/index.d.ts:40

Add a listener for a given event.

Type Parameters​

T​

T extends string | symbol

Parameters​

event​

T

fn​

(...args) => void

context?​

any

Returns​

this

Inherited from​

EventEmitter.on

once()​

once<T>(
   event, 
   fn, 
   context?): this;

Defined in: node_modules/eventemitter3/index.d.ts:54

Add a one-time listener for a given event.

Type Parameters​

T​

T extends string | symbol

Parameters​

event​

T

fn​

(...args) => void

context?​

any

Returns​

this

Inherited from​

EventEmitter.once

removeAllListeners()​

removeAllListeners(event?): this;

Defined in: node_modules/eventemitter3/index.d.ts:79

Remove all listeners, or those of the specified event.

Parameters​

event?​

string | symbol

Returns​

this

Inherited from​

EventEmitter.removeAllListeners

removeListener()​

removeListener<T>(
   event, 
   fn?, 
   context?, 
   once?): this;

Defined in: node_modules/eventemitter3/index.d.ts:63

Remove the listeners of a given event.

Type Parameters​

T​

T extends string | symbol

Parameters​

event​

T

fn?​

(...args) => void

context?​

any

once?​

boolean

Returns​

this

Inherited from​

EventEmitter.removeListener

start()​

start(): Promise<AppsConnectionsOpenResponse>;

Defined in: src/SocketModeClient.ts:162

Start a Socket Mode session app. This method must be called before any messages can be sent or received, or to disconnect the client via the disconnect method.

Returns​

Promise<AppsConnectionsOpenResponse>