Interface: SocketModeOptions
Properties
appToken
appToken: string;
The App-level token associated with your app, located under the Basic Information page on api.slack.com/apps.
Defined in
packages/socket-mode/src/SocketModeOptions.ts:8
autoReconnectEnabled?
optional autoReconnectEnabled: boolean;
Whether the client should automatically reconnect when the socket mode connection is disrupted. Defaults to true.
Note that disconnects are regular and expected when using Socket Mode, so setting this to false will likely lead
to a disconnected client after some amount of time.
Defined in
packages/socket-mode/src/SocketModeOptions.ts:22
clientOptions?
optional clientOptions: Omit<WebClientOptions, "logLevel" | "logger">;
The @slack/web-api WebClientOptions to provide to the HTTP client interacting with Slack's HTTP API.
Useful for setting retry configurations, TLS and HTTP Agent options.
Defined in
packages/socket-mode/src/SocketModeOptions.ts:46
clientPingTimeout?
optional clientPingTimeout: number;
How long the client should wait for a pong response to the client's ping to the server, in milliseconds.
If this timeout is hit, the client will attempt to reconnect if autoReconnectEnabled is true;
otherwise, it will disconnect.
Defaults to 5,000.
Defined in
packages/socket-mode/src/SocketModeOptions.ts:29
logger?
optional logger: Logger;
An instance of @slack/logger's Logger interface, to send log messages to.
Defined in
packages/socket-mode/src/SocketModeOptions.ts:12
logLevel?
optional logLevel: LogLevel;
An instance of @slack/logger's LogLevel enum, setting the minimum log level to emit log messages for.
Defined in
packages/socket-mode/src/SocketModeOptions.ts:16
pingPongLoggingEnabled?
optional pingPongLoggingEnabled: boolean;
Should logging related to ping and pong messages between the client and server be logged at a
LogLevel.DEBUG level. Defaults to `false.
Defined in
packages/socket-mode/src/SocketModeOptions.ts:41
serverPingTimeout?
optional serverPingTimeout: number;
How long the client should wait for ping messages from the server, in milliseconds.
If this timeout is hit, the client will attempt to reconnect if autoReconnectEnabled is true;
otherwise, it will disconnect.
Defaults to 30,000.