botbuilder-dialogs-adaptive/lib/actions/breakLoop.d.ts

Rule system for the Microsoft BotBuilder dialog system.

import { BoolExpression } from 'adaptive-expressions';
import { BoolProperty } from '../properties';
import { Converter, ConverterFactory, DialogTurnResult, Dialog, DialogContext, DialogConfiguration } from 'botbuilder-dialogs';
export interface BreakLoopConfiguration extends DialogConfiguration {
    disabled?: BoolProperty;
}
/**
 * Break out of a loop.
 */
export declare class BreakLoop<O extends object = {}> extends Dialog<O> implements BreakLoopConfiguration {
    static $kind: string;
    /**
     * An optional expression which if is true will disable this action.
     */
    disabled?: BoolExpression;
    /**
     * @param property The key of the conditional selector configuration.
     * @returns The converter for the selector configuration.
     */
    getConverter(property: keyof BreakLoopConfiguration): Converter | ConverterFactory;
    /**
     * Called when the [Dialog](xref:botbuilder-dialogs.Dialog) is started and pushed onto the dialog stack.
     *
     * @param dc The [DialogContext](xref:botbuilder-dialogs.DialogContext) for the current turn of conversation.
     * @param _options Optional. Initial information to pass to the dialog.
     * @returns A `Promise` representing the asynchronous operation.
     */
    beginDialog(dc: DialogContext, _options?: O): Promise<DialogTurnResult>;
    /**
     * @protected
     * Builds the compute Id for the [Dialog](xref:botbuilder-dialogs.Dialog).
     * @returns A `string` representing the compute Id.
     */
    protected onComputeId(): string;
}
//# sourceMappingURL=breakLoop.d.ts.map