ICallSessionOptions interface

Package:

botbuilder-calling

Options passed to the constructor of a session.

Properties

autoBatchDelay	(Optional) time to allow between each message sent as a batch. The default value is 150ms.
dialogArgs	(Optional) arguments to pass to the conversations initial dialog.
dialogErrorMessage	Default error message to send users when a dialog error occurs.
dialogId	Unique ID of the dialog to use when starting a new conversation with a user.
library	The bots root library of dialogs.
localizer	(Optional) localizer to use when localizing the bots responses.
middleware	Array of session middleware to execute prior to each request.
onSave	Function to invoke when the sessions state is saved.
onSend	Function to invoke when a batch of messages are sent.
promptDefaults	Default prompt settings to use.
recognizeDefaults	Default recognizer settings to use.
recordDefaults	Default recording settings to use.

Property Details

autoBatchDelay

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

autoBatchDelay?: number

Property Value

number

dialogArgs

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

dialogArgs?: any

Property Value

any

dialogErrorMessage

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

dialogErrorMessage?: string | string[] | IAction | IIsAction

Property Value

string | string[] | IAction | IIsAction

dialogId

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

dialogId: string

Property Value

string

library

The bots root library of dialogs.

library: Library

Property Value

Library

localizer

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

localizer?: ILocalizer

Property Value

ILocalizer

middleware

Array of session middleware to execute prior to each request.

middleware: ICallSessionMiddleware[]

Property Value

ICallSessionMiddleware[]

onSave

Function to invoke when the sessions state is saved.

onSave: (done: (err: Error) => void) => void

Property Value

(done: (err: Error) => void) => void

onSend

Function to invoke when a batch of messages are sent.

onSend: (messages: IEvent[], done: (err: Error) => void) => void

Property Value

(messages: IEvent[], done: (err: Error) => void) => void

promptDefaults

Default prompt settings to use.

promptDefaults: IPrompt

Property Value

IPrompt

recognizeDefaults

Default recognizer settings to use.

recognizeDefaults: IRecognizeAction

Property Value

IRecognizeAction

recordDefaults

Default recording settings to use.

recordDefaults: IRecordAction

Property Value

IRecordAction