Widget properties
The set of properties in this table defines both:
-
how a widget is displayed in a chat transcript
-
how a widget behaves when a user interacts with it
Property | Description | Supported values | Required |
---|---|---|---|
displayInRestore
|
Indicates whether to restore rich mean when reloading the chat window, which usually happens when the user navigates to a new page. In most cases, accept the default value. |
|
no |
historicHidden
|
Indicates whether to display the widget from previous conversations. Note: This property is relevant only to asynchronous conversations. |
|
no |
historicLockView
|
Indicates whether to disable widget controls from previous conversations. Note: This property is relevant only to asynchronous conversations. |
|
no |
initialView
|
The node ID of the node to display first. |
For more information, see |
required only if widget contains multiple nodes |
lockView
|
Indicates whether to disable the widget controls after the user completes the interaction. |
|
no |
pagination
|
Displays a bar at the top of the widget to show the page where the user is located. The position of the bar is based on the position order of the node in the list of nodes. This property is an object containing two key/value pairs:
Note: This property is relevant only to widgets with multiple nodes or pages. |
|
no |
showMessageText
|
Indicates whether to display any accompanying Note: Messages sent with this flag do not display an agent avatar. |
|
no |
showMessageTextInRestore
|
Indicates whether to display any accompanying |
Defaults to the value of
|
no |
type
|
Rich-media type. | The type for each widget is listed in the corresponding topic in the Widget reference. |
yes |
widgetAction
|
Indicates whether the user can continue to type and send messages without interacting with the widget. |
|
yes |
widgetType
|
Facilitates CSS customization. This string is added as a class to your widget inside the “nuance-widget-container” element when it is rendered in HTML. For example, if a sales flow has a different visual design than a support flow, specifying the |
This property accepts any text string. It defaults to null. |
no |
widgetView
|
Indicates whether widget is displayed inside or outside the agent’s speech bubble. |
|
yes |