Class WebSocketClient

Websocket client

Hierarchy

WebSocketClient

Index

Constructors

Properties

#connection #eventTarget brandId channelId customerId onError options visitorId

Methods

#setupConnection #socketEventHandler _errorHandler connect disconnect off on reconnect send

Constructors

constructor

new WebSocketClient(brandId, channelId, customerId, options, onError, visitorId): WebSocketClient
Parameters
- brandId: BrandId
- channelId: ChannelId
- customerId: CustomerIdentityIdOnExternalPlatform
- options: WebSocketClientOptions
- onError: undefined | ((error) => void)
- visitorId: VisitorId
Returns WebSocketClient

Properties

`Private` #connection

#connection: null | WebSocketClient = null

`Private` #eventTarget

#eventTarget: WebSocketClient

`Private` brandId

brandId: BrandId

`Private` channelId

channelId: ChannelId

`Private` customerId

customerId: CustomerIdentityIdOnExternalPlatform

`Private` onError

onError: undefined | ((error) => void)

Type declaration

- (error): void
- Parameters
  - error: Error
  Returns void

`Private` options

options: WebSocketClientOptions

`Private` visitorId

visitorId: VisitorId

Methods

`Private` #setupConnection

#setupConnection(token?): void
Parameters
- Optional token: string
Returns void

`Private` #socketEventHandler

#socketEventHandler(event): void
Parameters
- event: CustomEvent<Event | ErrorEvent | CloseEvent>
Returns void

`Private` _errorHandler

_errorHandler(event): void
Handle error from event listeners with onError callback or throw error
Parameters
- event: CustomEvent<Event | ErrorEvent | CloseEvent>
Returns void

connect

connect(token?): Promise<void>
Connect websocket
Parameters
- Optional token: string
Returns Promise<void>

disconnect

disconnect(): void
Disconnect websocket

Returns void

off

off(eventType, handlerCallback): void
Unregister event handler to websocket event
Parameters
- eventType: WebSocketClientEvent
  
  websocket event
- handlerCallback: ((event) => void)
  
  event handler
  - - (event): void
    - Parameters
      
      event: CustomEvent<any>
      
      Returns void
Returns void

on

on(eventType, handlerCallback): void
Register event handler to websocket event
Parameters
- eventType: WebSocketClientEvent
  
  websocket event
- handlerCallback: ((event) => void)
  
  event handler
  - - (event): void
    - Parameters
      
      event: ChatCustomEvent<ChatEventData>
      
      Returns void
Returns void

reconnect

reconnect(token?): void
Reconnect websocket
Parameters
- Optional token: string
Returns void

send

send(data): void
Send data to active connection
Parameters
- data: unknown
  
  data to send
Returns void

Generated using TypeDoc