Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Property

Description

speechToText: "native"

Defines the Speech-to-Text converter to be used by the chatbot application and it takes values such as native, default, and google.

"peekview": true

Defines if the Bot should load in Peek View on the host page.

"autoFocus": false

When false, the chatbot's focus remains on the action item unless manual input is made. If true, the focus is automatically managed.

"speechToTextLanguage": "Language Code"

Defines the Speech-to-Text language to be used by the chatbot application.
Refer, https://cloud.google.com/text-to-speech/docs/voices for the Language Code.

waitTime: "250"

Defines the amount of time (in milliseconds) the bot waits before showing the next bubble. Also, see How do I delay delivering bubbles in Chatbot using waitTime?

micMode: "push"

Setting this property to push will not enable the mic when the chatbot loads. The chatbot user has to manually enable the mic to use it.

Setting this property to auto will enable the mic when the chatbot loads. In short, a handsfree mode for the chatbot.

animationTime: "500"

(for buttons)

This property defines the amount of time (in milliseconds) the loading animation renders the buttons in the chatbot.

The animation time will kick in only when the chatbot’s scroll is visible i.e; when the chat bubbles occupy/fill the entirechatbot window.

The animation time is calculated based on the
animation_time * (number_of_bubbles /2)

startAlignmentTop: true

When this property value is set to true, the chat bubbles are loaded from the top of the chatbot first.

enablePreviousOptions: true

When this property value is set to true. The options displayed to the chatbot user will be visible highlighting the option chosen by the user.

waitSettings: {
mode: 'dynamic',
wpm: 165
}

This property introduces dynamic wait time based on the text in the previous chat bubble.
The mode can be dynamic or static.

  • If set to dynamic, the duration of wait time animation will be calculated based on the number of words rendered on the previous bubble. ((#of words in the last bubble ) / (Word Per Minute) ) * 1000

  • If set to static, the duration of wait time animation is taken from the property msg.payload.waitTime

More information at How do I delay delivering bubbles in Chatbot using waitTime?

logoutUtterance: "utterance"

When you click the logout button, the utterance set in this property will be passed to the server.

logoutUrls: "URL"

This URL will be called when the chatbot user clicks on the logout button.

logoutText: "text"

You can rename the logout button using this property

keyboardPlaceholderText: "Placeholder text"

The text passed in this property is displayed in the keyboard input box.

rePromptWaitTime: "500"

Defines the amount of time (in milliseconds) the chatbot waits before saying the reprompt question.

You can use the reprompt wait time by assigning a value greater than zero.

  • If the rePromptWaitTime property is not set, it will take the default value as zero.

  • If the rePromptWaitTime property is already set to a positive value, it will be maintained after the upgrade.

Info

Note: Reprompt works only if the original question is not answered yet.

offlineMessage : 'You lost your Internet connectivity'

The message that is displayed when the chatbot user is offline. You cannot do any action in the chatbot when offline.

onlineMessage : 'You are online'

The message that is displayed when the chatbot user is back online.

"banner": {"title":"","message":""}

The message can hold HTML links, content for the banner.

...