Versions Compared

Key

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

...

All the properties listed below should be used under the property msg.payload.<App Settings property>.
For example, to change waitTime to 500 ms, you have to use msg.payload.waitTime: "500"

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.

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"

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

The animation is shown before rendering the chat bubble.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 chatbubbles chat bubbles are loaded from the top of the chatbot first.

Image RemovedImage Added

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 When you click the logout button is clicked, the utterance set in this utterance property will be passed to the server.

logoutUrls: “URL“

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

logoutText: “text“

When You can rename the logout button is clicked, you will get this text as response from the chatbot.mapKeyusing this property

keyboardPlaceholderText: "Placeholder text"

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

Image RemovedImage Added

rePromptWaitTime: "500"

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

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.

...