botbuilder-dialogs
Version:
A dialog stack based conversation manager for Microsoft BotBuilder.
101 lines (100 loc) • 3.2 kB
TypeScript
/**
* @module botbuilder-dialogs
*/
/**
* Copyright (c) Microsoft Corporation. All rights reserved.
* Licensed under the MIT License.
*/
import { DialogReason, DialogTurnResult } from './dialog';
import { DialogContext } from './dialogContext';
/**
* Values passed to the `WaterfallStepContext` constructor.
*/
export interface WaterfallStepInfo<O extends object> {
/**
* The index of the current waterfall step being executed.
*/
index: number;
/**
* Any options passed to the steps waterfall dialog when it was started with
* `DialogContext.beginDialog()`.
*/
options: O;
/**
* The reason the waterfall step is being executed.
*/
reason: DialogReason;
/**
* Results returned by a dialog or prompt that was called in the previous waterfall step.
*/
result: any;
/**
* A dictionary of values which will be persisted across all waterfall steps.
*/
values: object;
/**
* Called to skip to the next waterfall step.
*
* @param result (Optional) result to pass to the next step.
*/
onNext(result?: any): Promise<DialogTurnResult>;
}
/**
* Context object passed in to a `WaterfallStep`.
*
* @param O (Optional) type of options passed to the steps waterfall dialog in the call to `DialogContext.beginDialog()`.
*/
export declare class WaterfallStepContext<O extends object = {}> extends DialogContext {
private _info;
/**
* Creates a new WaterfallStepContext instance.
*
* @param dc The dialog context for the current turn of conversation.
* @param info Values to initialize the step context with.
*/
constructor(dc: DialogContext, info: WaterfallStepInfo<O>);
/*
* The index of the current waterfall step being executed.
*
* @returns The index of the current waterfall step being executed.
*/
readonly index: number;
/*
* Any options passed to the steps waterfall dialog when it was started with
* `DialogContext.beginDialog()`.
*
* @returns Any options the waterfall dialog was called with.
*/
readonly options: O;
/*
* The reason the waterfall step is being executed.
*
* @returns The reason the waterfall step is being executed.
*/
readonly reason: DialogReason;
/*
* Results returned by a dialog or prompt that was called in the previous waterfall step.
*
* @returns The result from the previous waterfall step.
*/
readonly result: any;
/*
* A dictionary of values which will be persisted across all waterfall steps.
*
* @returns A dictionary of values which will be persisted across all waterfall steps.
*/
readonly values: object;
/**
* Skips to the next waterfall step.
*
* @remarks
*
* ```JavaScript
* return await step.skip();
* ```
* @param result (Optional) result to pass to the next step.
* @returns A promise with the DialogTurnResult.
*/
next(result?: any): Promise<DialogTurnResult>;
}
//# sourceMappingURL=waterfallStepContext.d.ts.map