Constructor
-
new NotificationInfo()
-
Creates an instance of NotificationInfo that contains information for
AvayaCustomerServices SDK to communicate with an asynchronous
notification service.
Members
-
attachHeadersAsQueryString :array|boolean
-
Attach filtered list of headers (array), no headers(false) or all headers(true) as query string
Type:
- array | boolean
-
broadcastUrl :string
-
Broadcast Url for Notification Provider.
Type:
- string
-
dropHeaders :array|boolean
-
Remove filtered list of headers (array), no headers(false) or all headers(true)
Type:
- array | boolean
-
enableXDR :boolean
-
Enable CORS Cross Origin Resource Sharing.
Type:
- boolean
-
fallbackTransport :string
-
If either the client or server isn't able to support the selected 'transport', the fallback value will be used.
Type:
- string
- Since:
-
- 3.2.2
-
headers :object
-
A list of headers to send
Type:
- object
-
logLevel :string
-
Notification log level.
Type:
- string
-
maxReconnectOnClose :number
-
The maximum reconnect after a connection is marked as 'dead'.
Type:
- number
-
name :string
-
Name of Notification Provider.
Type:
- string
- Since:
-
- 3.3.0.0
-
onBeforeUnload :function|null
-
Function to call before notification provider closes session on page unload
Type:
- function | null
-
reconnectInterval :number
-
The interval in milliseconds before an attempt to reconnect will be made.
Type:
- number
-
timeout :number
-
The maximum time a connection stays open
Type:
- number
-
trackMessageLength :boolean
-
Track the size of the received request.
Type:
- boolean
-
transport :string
-
The transport Notification will use between the client and server.
Type:
- string
Methods
-
onClose(callback)
-
Adds a callback that is executed when notification provider closes a connection
Parameters:
Name Type Description callback
AvayaCustomerServices.Config.NotificationInfo~onClose - Since:
-
- 3.5.0.0
Type Definitions
-
onClose(message)
-
Parameters:
Name Type Description message
AvayaCustomerServices.Base.Error The event that is fired when notification provider closes a connection