botbuilder-dialogs
Version:
A dialog stack based conversation manager for Microsoft BotBuilder.
95 lines • 4.47 kB
JavaScript
;
var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
return new (P || (P = Promise))(function (resolve, reject) {
function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
step((generator = generator.apply(thisArg, _arguments || [])).next());
});
};
Object.defineProperty(exports, "__esModule", { value: true });
exports.TextPrompt = void 0;
/**
* @module botbuilder-dialogs
*/
/**
* Copyright (c) Microsoft Corporation. All rights reserved.
* Licensed under the MIT License.
*/
const botbuilder_core_1 = require("botbuilder-core");
const prompt_1 = require("./prompt");
/**
* Prompts a user to enter some text.
*
* @remarks
* By default the prompt will return to the calling dialog a `string` representing the users reply.
*/
class TextPrompt extends prompt_1.Prompt {
/**
* Creates a new TextPrompt instance.
*
* @param dialogId (Optional) unique ID of the dialog within its parent `DialogSet` or `ComponentDialog`.
* @param validator (Optional) validator that will be called each time the user responds to the prompt.
*/
constructor(dialogId, validator) {
super(dialogId, validator);
}
/**
* Prompts the user for input.
*
* @param context [TurnContext](xref:botbuilder-core.TurnContext), context for the current
* turn of conversation with the user.
* @param state Contains state for the current instance of the prompt on the dialog stack.
* @param options A [PromptOptions](xref:botbuilder-dialogs.PromptOptions) object constructed
* from the options initially provided in the call to Prompt.
* @param isRetry `true` if this is the first time this prompt dialog instance
* on the stack is prompting the user for input; otherwise, false.
* @returns A `Promise` representing the asynchronous operation.
*/
onPrompt(context, state, options, isRetry) {
return __awaiter(this, void 0, void 0, function* () {
if (isRetry && options.retryPrompt) {
yield context.sendActivity(options.retryPrompt, undefined, botbuilder_core_1.InputHints.ExpectingInput);
}
else if (options.prompt) {
yield context.sendActivity(options.prompt, undefined, botbuilder_core_1.InputHints.ExpectingInput);
}
});
}
/**
* Attempts to recognize the user's input.
*
* @param context [TurnContext](xref:botbuilder-core.TurnContext), context for the current
* turn of conversation with the user.
* @param _state Contains state for the current instance of the prompt on the dialog stack.
* @param _options A [PromptOptions](xref:botbuilder-dialogs.PromptOptions) object constructed
* from the options initially provided in the call to Prompt.
* @returns A `Promise` representing the asynchronous operation.
*/
onRecognize(context, _state, _options) {
return __awaiter(this, void 0, void 0, function* () {
const value = context.activity.text;
return typeof value === 'string' && value.length > 0 ? { succeeded: true, value: value } : { succeeded: false };
});
}
/**
* Called before an event is bubbled to its parent.
*
* @param _dc The [DialogContext](xref:botbuilder-dialogs.DialogContext) for the current
* turn of conversation.
* @param _event [DialogEvent](xref:botbuilder-dialogs.DialogEvent), the event being raised.
* @returns Whether the event is handled by the current dialog and further processing should stop.
* @remarks
* This is a good place to perform interception of an event as returning `true` will prevent
* any further bubbling of the event to the dialogs parents and will also prevent any child
* dialogs from performing their default processing.
*/
onPreBubbleEvent(_dc, _event) {
return __awaiter(this, void 0, void 0, function* () {
return false;
});
}
}
exports.TextPrompt = TextPrompt;
//# sourceMappingURL=textPrompt.js.map