AbstractCreates a new instance of the Dialog class.
OptionaldialogId: stringOptional. unique ID of the dialog.
ReadonlydialogsThe containers dialog set.
StaticEndGets a default end-of-turn result.
Sets the unique ID of the dialog.
AbstractbeginWhen overridden in a derived class, starts the dialog.
The context for the current dialog turn.
Optionaloptions: OOptional. Arguments to use when the dialog starts.
Derived dialogs must override this method.
The DialogContext calls this method when it creates a new DialogInstance for this dialog, pushes it onto the dialog stack, and starts the dialog.
A dialog that represents a single-turn conversation should await DialogContext.endDialog before exiting this method.
ProtectedcheckChecks to see if a containers child dialogs have changed since the current dialog instance was started.
Current dialog context.
Fluent method for configuring the object.
Configuration settings to apply.
The Configurable after the operation is complete.
When overridden in a derived class, continues the dialog.
The context for the current dialog turn.
A promise resolving to the dialog turn result.
Derived dialogs that support multiple-turn conversations should override this method. By default, this method signals that the dialog is complete and returns.
The DialogContext calls this method when it continues the dialog.
To signal to the dialog context that this dialog has completed, await DialogContext.endDialog before exiting this method.
AbstractcreateCreates an inner dialog context for the containers active child.
Parents dialog context.
A new dialog context for the active child or undefined if there is no active child.
When overridden in a derived class, performs clean up for the dialog before it ends.
The context object for the turn.
Current state information for this dialog.
The reason the dialog is ending.
Derived dialogs that need to perform logging or cleanup before ending should override this method. By default, this method has no effect.
The DialogContext calls this method when the current dialog is ending.
Finds a child dialog that was previously added to the container.
ID of the dialog to lookup.
The Dialog if found; otherwise null.
Gets the converter for the selector configuration. *
The key of the conditional selector configuration. *
The converter for the selector configuration.
ProtectedgetReturns internal version identifier for this container.
Version which represents the change of the internals of this container.
DialogContainers detect changes of all sub-components in the container and map that to a versionChanged event.
Because they do this, DialogContainers "hide" the internal changes and just have the .id. This isolates changes
to the container level unless a container doesn't handle it. To support this DialogContainers define a
protected method getInternalVersion() which computes if this dialog or child dialogs have changed
which is then examined via calls to checkForVersionChange().
An encoded string used to aid in the detection of agent changes on re-deployment.
Unique string which should only change when dialog has changed in a way that should restart the dialog.
This defaults to returning the dialog's id but can be overridden to provide more
precise change detection logic. Any dialog on the stack that has its version change will
result in a versionChanged event will be raised. If this event is not handled by the agent,
an error will be thrown resulting in the agent error handler logic being run.
Returning an empty string will disable version tracking for the component all together.
ProtectedonCalled when an event has been raised, using DialogContext.emitEvent(),
by either the current dialog or a dialog that the current dialog started.
The dialog context for the current turn of conversation.
The event being raised.
True if the event is handled by the current dialog and bubbling should stop.
ProtectedonCalled after an event was bubbled to all parents and wasn't handled.
The dialog context for the current turn of conversation.
The event being raised.
Whether the event is handled by the current dialog and further processing should stop.
ProtectedonCalled before an event is bubbled to its parent.
The dialog context for the current turn of conversation.
The event being raised.
Whether the event is handled by the current dialog and further processing should stop.
When overridden in a derived class, prompts the user again for input.
The context object for the turn.
Current state information for this dialog.
Derived dialogs that support validation and re-prompt logic should override this method. By default, this method has no effect.
The DialogContext calls this method when the current dialog should re-request input from the user. This method is implemented for prompt dialogs.
When overridden in a derived class, resumes the dialog after the dialog above it on the stack completes.
The context for the current dialog turn.
The reason the dialog is resuming. This will typically be DialogReason.endCalled
Optionalresult: anyOptional. The return value, if any, from the dialog that ended.
A promise resolving to the dialog turn result.
Derived dialogs that support multiple-turn conversations should override this method. By default, this method signals that the dialog is complete and returns.
The DialogContext calls this method when it resumes
the dialog. If the previous dialog on the stack returned a value, that value is in the result
parameter.
To start a child dialog, use DialogContext.beginDialog or DialogContext.prompt; however, this dialog will not necessarily be the one that started the child dialog. To signal to the dialog context that this dialog has completed, await DialogContext.endDialog before exiting this method.
A container for a set of Dialogs.