Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface ISessionOptions

Options passed to the constructor of a session.

Hierarchy

  • ISessionOptions

Index

Properties

Optional actions

actions: ActionSet

Global actions registered for the bot.

Optional autoBatchDelay

autoBatchDelay: number

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

connector

connector: IConnector

The connector being used for this session.

Optional dialogArgs

dialogArgs: any

(Optional) arguments to pass to the conversations initial dialog.

Optional dialogErrorMessage

dialogErrorMessage: TextOrMessageType

Default error message to send users when a dialog error occurs.

dialogId

dialogId: string

Unique ID of the dialog to use when starting a new conversation with a user.

library

library: Library

The bots root library of dialogs.

localizer

localizer: ILocalizer

The localizer to use for the session.

middleware

middleware: ISessionMiddleware[]

Array of session middleware to execute prior to each request.

onSave

onSave: function

Function to invoke when the sessions state is saved.

Type declaration

    • (done: function): void
    • Parameters

      • done: function
          • (err: Error): void
          • Parameters

            • err: Error

            Returns void

      Returns void

onSend

onSend: function

Function to invoke when a batch of messages are sent.

Type declaration

    • (messages: IMessage[], done: function): void
    • Parameters

      • messages: IMessage[]
      • done: function
          • (err: Error, addresses?: IAddress[]): void
          • Parameters

            • err: Error
            • Optional addresses: IAddress[]

            Returns void

      Returns void

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