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

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

    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.

    interface DialogInstance<T = any> {
        id: string;
        state: T;
        version?: string;
    }

    Type Parameters

    • T = any

      Optional. The type that represents state information for the dialog.

    Index

    Properties

    Properties

    id: string

    ID of this dialog

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

    state: T

    The state information for this instance of this dialog.

    version?: string

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