Edit

Share via

DialogManager class

Package:
botbuilder-dialogs

Warning

This API is now deprecated.

This class will be deprecated.

Class which runs the dialog system.

Extends
Configurable

Constructors

DialogManager(Dialog, string)

Creates an instance of the DialogSet class.

Properties

conversationState

Bots persisted conversation state.
dialogs

Global dialogs that you want to have be callable.
expireAfter

Optional. Number of milliseconds to expire the bots conversation state after.
initialTurnState

Values that will be copied to the TurnContext.turnState at the beginning of each turn.
rootDialog

Root dialog to start from onTurn() method. Gets the root Dialog ID.
stateConfiguration

Optional. Path resolvers and memory scopes used for conversations with the bot.
userState

Optional. Bots persisted user state.

Methods

configure(Partial<DialogManagerConfiguration>)

Set configuration settings.
onTurn(TurnContext)

Runs dialog system in the context of a TurnContext.

Inherited Methods

getConverter(string)

Constructor Details

DialogManager(Dialog, string)

Creates an instance of the DialogSet class.

new DialogManager(rootDialog?: Dialog, dialogStateProperty?: string)

Parameters

rootDialog
Dialog

Optional, root Dialog to use.

dialogStateProperty

string

Optional, alternate name for the dialogState property. (Default is "DialogStateProperty")

Property Details

conversationState

Bots persisted conversation state.

conversationState: ConversationState

Property Value

ConversationState

dialogs

Global dialogs that you want to have be callable.

dialogs: DialogSet

Property Value

DialogSet

expireAfter

Optional. Number of milliseconds to expire the bots conversation state after.

expireAfter?: number

Property Value

number

initialTurnState

Values that will be copied to the TurnContext.turnState at the beginning of each turn.

TurnContextStateCollection initialTurnState

Property Value

TurnContextStateCollection

The turn state collection.

rootDialog

Root dialog to start from onTurn() method. Gets the root Dialog ID.

Dialog rootDialog

Property Value

Dialog

The root Dialog ID.

stateConfiguration

Optional. Path resolvers and memory scopes used for conversations with the bot.

stateConfiguration?: DialogStateManagerConfiguration

Property Value

DialogStateManagerConfiguration

userState

Optional. Bots persisted user state.

userState?: UserState

Property Value

UserState

Method Details

configure(Partial<DialogManagerConfiguration>)

Set configuration settings.

function configure(config: Partial<DialogManagerConfiguration>): this

Parameters

config

Partial<DialogManagerConfiguration>

Configuration settings to apply.

Returns

this

The cofigured DialogManager context.

onTurn(TurnContext)

Runs dialog system in the context of a TurnContext.

function onTurn(context: TurnContext): Promise<DialogManagerResult>

Parameters

context

TurnContext

(xref:botbuilder-core.TurnContext) for the current turn of conversation with the user.

Returns

Promise<DialogManagerResult>

Result of running the logic against the activity.

Inherited Method Details

getConverter(string) 

function getConverter(_property: string): Converter | ConverterFactory

Parameters

_property

string

The key of the conditional selector configuration.

Returns

Converter | ConverterFactory

The converter for the selector configuration.

Inherited From Configurable.getConverter