Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface ICallSessionOptions

Options passed to the constructor of a session.

Hierarchy

  • ICallSessionOptions

Index

Properties

Optional autoBatchDelay

autoBatchDelay: number

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

Optional dialogArgs

dialogArgs: any

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

Optional dialogErrorMessage

dialogErrorMessage: string | string[] | IAction | IIsAction

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.

Optional localizer

localizer: ILocalizer

(Optional) localizer to use when localizing the bots responses.

middleware

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: IEvent[], done: function): void
    • Parameters

      • messages: IEvent[]
      • done: function
          • (err: Error): void
          • Parameters

            • err: Error

            Returns void

      Returns void

promptDefaults

promptDefaults: IPrompt

Default prompt settings to use.

recognizeDefaults

recognizeDefaults: IRecognizeAction

Default recognizer settings to use.

recordDefaults

recordDefaults: IRecordAction

Default recording settings to use.

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