type2docfx
Version:
A tool to convert json format output from TypeDoc to universal reference model for DocFx to consume.
58 lines (57 loc) • 1.88 kB
TypeScript
/**
* @module botbuilder-dialogs
*/
/**
* Copyright (c) Microsoft Corporation. All rights reserved.
* Licensed under the MIT License.
*/
import { Dialog } from '../dialog';
import { DialogSet } from '../dialogSet';
import { PromptOptions, PromptValidator } from './prompt';
/**
* Prompts a user to enter some text. By default the prompt will return to the calling
* dialog a `string` representing the users reply.
*
* **Example usage:**
*
* ```JavaScript
* const { DialogSet, TextPrompt } = require('botbuilder-dialogs');
*
* const dialogs = new DialogSet();
*
* dialogs.add('textPrompt', new TextPrompt());
*
* dialogs.add('textDemo', [
* function (context) {
* return dialogs.prompt(context, 'textPrompt', `text: enter some text`);
* },
* function (context, value) {
* context.reply(`Recognized value: ${value}`);
* return dialogs.end(context);
* }
* ]);
* ```
*/
export declare class TextPrompt implements Dialog {
private validator;
/**
* Creates a new instance of the prompt.
*
* **Example usage:**
*
* ```JavaScript
* dialogs.add('titlePrompt', new TextPrompt((context, value) => {
* if (value.length < 3) {
* context.reply(`Title should be at least 3 characters long.`);
* return Promise.resolve();
* } else {
* return dialogs.end(context, value.trim());
* }
* }));
* ```
* @param validator (Optional) validator that will be called each time the user responds to the prompt.
*/
constructor(validator?: PromptValidator<string> | undefined);
begin(context: BotContext, dialogs: DialogSet, options: PromptOptions): Promise<void>;
continue(context: BotContext, dialogs: DialogSet): Promise<void>;
}