Class ConnectionHandler

Description

Connection handler. This handler provides callbacks for automatically managed reconnection events. SendbirdChat tries reconnection when the connection is lost. This handler can be used to track the reconnection state. To add or remove this handler, refer to sendbirdChat.addConnectionHandler() and sendbirdChat.removeConnectionHandler().

Hierarchy

  • ConnectionHandlerParams
    • ConnectionHandler

Constructors

constructor

Properties

onConnected? onConnectionDelayed? onDisconnected? onReconnectFailed? onReconnectStarted? onReconnectSucceeded?

Constructors

constructor

Properties

OptionalonConnected

onConnected?: ((userId: string) => void) = noop

A callback for when SendbirdChat is connected.

OptionalonConnectionDelayed

onConnectionDelayed?: ((retryAfterTime: number) => void) = noop

A callback for when connection is delayed.

OptionalonDisconnected

onDisconnected?: ((userId: string) => void) = noop

A callback for when SendbirdChat is disconnected.

OptionalonReconnectFailed

onReconnectFailed?: (() => void) = noop

A callback for when reconnection is failed.

OptionalonReconnectStarted

onReconnectStarted?: (() => void) = noop

A callback for when SendbirdChat tries to reconnect.

OptionalonReconnectSucceeded

onReconnectSucceeded?: (() => void) = noop

A callback for when connection is reestablished.

Settings

Member Visibility

On This Page

Constructors
Properties