IUniversalBotSettings interface
Options used to initialize a UniversalBot instance.
Properties
auto |
(Optional) time to allow between each message sent as a batch. The default value is 150ms. |
default |
(Optional) arguments to pass to the initial dialog for a conversation. |
default |
(Optional) dialog to launch when a user initiates a new conversation with a bot. Default value is '/'. |
dialog |
(Optional) message to send the user should an unexpected error occur during a conversation. A default message is provided. |
localizer |
(Optional) settings used to configure the frameworks built in default localizer. |
lookup |
(Optional) function used to map the user ID for an incoming message to another user ID. This can be used to implement user account linking. |
persist |
(Optional) if true shared conversationData will be persisted. The default value is false. |
persist |
(optional) if true userData will be persisted. The default value is true. |
process |
(Optional) maximum number of async options to conduct in parallel. |
storage | (Optional) storage system to use for storing user & conversation data. |
Property Details
autoBatchDelay
(Optional) time to allow between each message sent as a batch. The default value is 150ms.
autoBatchDelay?: number
Property Value
number
defaultDialogArgs
(Optional) arguments to pass to the initial dialog for a conversation.
defaultDialogArgs?: any
Property Value
any
defaultDialogId
(Optional) dialog to launch when a user initiates a new conversation with a bot. Default value is '/'.
defaultDialogId?: string
Property Value
string
dialogErrorMessage
(Optional) message to send the user should an unexpected error occur during a conversation. A default message is provided.
dialogErrorMessage?: TextOrMessageType
Property Value
localizerSettings
(Optional) settings used to configure the frameworks built in default localizer.
localizerSettings?: IDefaultLocalizerSettings
Property Value
lookupUser
(Optional) function used to map the user ID for an incoming message to another user ID. This can be used to implement user account linking.
lookupUser?: (address: IAddress, done: (err: Error, user: IIdentity) => void) => void
Property Value
(address: IAddress, done: (err: Error, user: IIdentity) => void) => void
persistConversationData
(Optional) if true shared conversationData will be persisted. The default value is false.
persistConversationData?: boolean
Property Value
boolean
persistUserData
(optional) if true userData will be persisted. The default value is true.
persistUserData?: boolean
Property Value
boolean
processLimit
(Optional) maximum number of async options to conduct in parallel.
processLimit?: number
Property Value
number
storage
(Optional) storage system to use for storing user & conversation data.
storage?: IBotStorage