Class: WebsocketInfo

Constructor

new WebsocketInfo()

Creates an instance of WebsocketInfo that contains information for
AvayaCustomerServices SDK to communicate with an asynchronous
notification service.

Members

autoResync :boolean

Attempts to auto resync data when connection is re-established

Type:
  • boolean

broadcastUrl :string

The URL to which to connect; this should be the URL to which the WebSocket server will respond.

Type:
  • string

clientHeartbeatInterval :number

The time interval (in milliseconds) between client heartbeat messages sent to server

Type:
  • number

heartbeatPadding :string

The payload of the heartbeat message sent from client to server

Type:
  • string

maxReconnectAttempts :number

The maximum number of attempts to re-establish a websocket connection.

Type:
  • number

name :string

Name of Notification Provider.

Type:
  • string

protocols :string|Array.<string>

Either a single protocol string or an array of protocol strings.
These strings are used to indicate sub-protocols, so that a single server can implement multiple WebSocket sub-protocols

Type:
  • string | Array.<string>

reconnectInterval :number

The number of milliseconds to wait before attempting to reconnect websocket connection.

Type:
  • number

reconnectOnServerTimeout :boolean

Attempts to re-establish a websocket connection if websocket becomes stale due to the serverHeartbeatTimeout

Type:
  • boolean

serverHeartbeatTimeout :number

The timeout duration (in milliseconds) client waits before regarding the websocket as stale

Type:
  • number
©2019 Avaya Inc. All Rights Reserved.