DialogInstance interface

Package:

botbuilder-dialogs

Contains state information for an instance of a dialog on the stack.

Remarks

This contains information for a specific instance of a dialog on a dialog stack. The dialog stack is associated with a specific dialog context and dialog set. Information about the dialog stack as a whole is persisted to storage using a dialog state object.

See also

• DialogState
• DialogContext
• DialogSet
• Dialog

Properties

id	ID of this dialog
state	The state information for this instance of this dialog.
version	Hash code used to detect that a dialog has changed since the curent instance was started.

Property Details

id

ID of this dialog

id: string

Property Value

string

Remarks

Dialog state is associated with a specific dialog set. This ID is the the dialog's id within that dialog set.

See also

• DialogState
• DialogSet

state

The state information for this instance of this dialog.

state: T

Property Value

T

version

Hash code used to detect that a dialog has changed since the curent instance was started.

version?: string

Property Value

string