Documentation - v1.2.0-alpha.3
    Preparing search index...

    Interface DialogTurnResult<T>

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

    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.

    interface DialogTurnResult<T = any> {
        parentEnded?: boolean;
        result?: T;
        status: DialogTurnStatus;
    }

    Type Parameters

    • T = any

      Optional. The type that represents a result returned by the active dialog when it successfully completes.

    Index

    Properties

    parentEnded? result? status

    Properties

    parentEnded?: boolean

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

    result?: T

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

    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: DialogTurnStatus

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

    Settings

    Member Visibility

    On This Page

    Properties