Edit

Share via

IUniversalBotSettings interface

Package:
botbuilder

Options used to initialize a UniversalBot instance.

Properties

autoBatchDelay

(Optional) time to allow between each message sent as a batch. The default value is 150ms.
defaultDialogArgs

(Optional) arguments to pass to the initial dialog for a conversation.
defaultDialogId

(Optional) dialog to launch when a user initiates a new conversation with a bot. Default value is '/'.
dialogErrorMessage

(Optional) message to send the user should an unexpected error occur during a conversation. A default message is provided.
localizerSettings

(Optional) settings used to configure the frameworks built in default localizer.
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.
persistConversationData

(Optional) if true shared conversationData will be persisted. The default value is false.
persistUserData

(optional) if true userData will be persisted. The default value is true.
processLimit

(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

TextOrMessageType

localizerSettings

(Optional) settings used to configure the frameworks built in default localizer.

localizerSettings?: IDefaultLocalizerSettings

Property Value

IDefaultLocalizerSettings

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

Property Value

IBotStorage