Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface IUniversalBotSettings

Options used to initialize a UniversalBot instance.

Hierarchy

  • IUniversalBotSettings

Index

Properties

Optional autoBatchDelay

autoBatchDelay: number

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

Optional defaultDialogArgs

defaultDialogArgs: any

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

Optional defaultDialogId

defaultDialogId: string

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

Optional dialogErrorMessage

dialogErrorMessage: TextOrMessageType

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

Optional localizerSettings

localizerSettings: IDefaultLocalizerSettings

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

Optional lookupUser

lookupUser: function

(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.

Type declaration

    • (address: IAddress, done: function): void
    • Parameters

      Returns void

Optional persistConversationData

persistConversationData: boolean

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

Optional persistUserData

persistUserData: boolean

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

Optional processLimit

processLimit: number

(Optional) maximum number of async options to conduct in parallel.

Optional storage

storage: IBotStorage

(Optional) storage system to use for storing user & conversation data.

Legend

  • Module
  • Object literal
  • Variable
  • Function
  • Function with type parameter
  • Index signature
  • Type alias
  • Enumeration
  • Enumeration member
  • Property
  • Method
  • Interface
  • Interface with type parameter
  • Constructor
  • Property
  • Method
  • Index signature
  • Class
  • Class with type parameter
  • Constructor
  • Property
  • Method
  • Accessor
  • Index signature
  • Inherited constructor
  • Inherited property
  • Inherited method
  • Inherited accessor
  • Protected property
  • Protected method
  • Protected accessor
  • Private property
  • Private method
  • Private accessor
  • Static property
  • Static method