DialogTurnResult interface

  • Reference
Package:
botbuilder-dialogs

Represents the result of a dialog context's attempt to begin, continue, or otherwise manipulate one or more dialogs.

Remarks

This can be used to determine if a dialog completed and a result is available, or if the stack was initially empty and a dialog should be started.

const dc = await dialogs.createContext(turnContext);
const result = await dc.continueDialog();

if (result.status == DialogTurnStatus.completed) {
    const survey = result.result;
    await submitSurvey(survey);
} else if (result.status == DialogTurnStatus.empty) {
    await dc.beginDialog('surveyDialog');
}

See also

Properties

parentEnded

If true, a DialogCommand has ended its parent container and the parent should not perform any further processing.
result

The result, if any, returned by the last dialog on the stack.
status

The state of the dialog stack after a dialog context's attempt.

Property Details

parentEnded

If true, a DialogCommand has ended its parent container and the parent should not perform any further processing.

parentEnded?: boolean

Property Value

boolean

result

The result, if any, returned by the last dialog on the stack.

result?: T

Property Value

T

Remarks

A result value is available only if the stack is now empty, the last dialog on the stack completed normally, and the last dialog returned a result to the dialog context.

status

The state of the dialog stack after a dialog context's attempt.

status: DialogTurnStatus

Property Value

DialogTurnStatus