import { TurnContext } from '@microsoft/agents-hosting'; import { Choice, ChoiceFactoryOptions } from '../choices'; import { ListStyle, Prompt, PromptOptions, PromptRecognizerResult, PromptValidator } from './prompt'; /** * Defines locale-specific choice defaults for confirmation prompts. * * @remarks * This interface represents a dictionary that maps locale strings to their corresponding * choice configurations for confirmation prompts. Each locale entry contains the localized * "yes" and "no" choices along with formatting options for how those choices should be * presented to the user. * * The interface is designed to support dynamic configuration of choice defaults using * lambda expressions or other dynamic assignment patterns. * * @example * ```typescript * const customChoiceDefaults: ChoiceDefaultsConfirmPrompt = { * 'en-us': { * choices: ['Yes', 'No'], * options: { * inlineSeparator: ', ', * inlineOr: ' or ', * includeNumbers: true * } * }, * 'es-es': { * choices: ['Sí', 'No'], * options: { * inlineSeparator: ', ', * inlineOr: ' o ', * includeNumbers: true * } * } * }; * ``` */ export interface ChoiceDefaultsConfirmPrompt { /** * Locale-specific choice configuration. * * @remarks * The key is a locale string (e.g., 'en-us', 'fr-fr', 'de-de') and the value * contains the localized choices and formatting options for that locale. * */ [locale: string]: { /** * Array of localized choice options, typically ["Yes", "No"] equivalents. * Can be either string values or Choice objects for more complex configurations. */ choices: (string | Choice)[]; /** * Formatting options that control how the choices are presented to the user, * including separators, conjunctions, and whether to include numbers. */ options: ChoiceFactoryOptions; }; } /** * Prompts a user to confirm something with a "yes" or "no" response. * * @remarks * By default the prompt will return to the calling dialog a `boolean` representing the users * selection. * */ export declare class ConfirmPrompt extends Prompt { /** * A dictionary of Default Choices based on {@link PromptCultureModels.getSupportedCultures | PromptCultureModels.getSupportedCultures} method. * Can be replaced by user using the constructor that contains choiceDefaults. * This is initially set in the constructor. */ private choiceDefaults; /** * The prompts default locale that should be recognized. */ defaultLocale: string | undefined; /** * Style of the "yes" and "no" choices rendered to the user when prompting. * * @remarks * Defaults to {@link ListStyle.auto}. * */ style: ListStyle; /** * Additional options passed to the {@link ChoiceFactory } and used to tweak the style of choices * rendered to the user. */ choiceOptions: ChoiceFactoryOptions | undefined; /** * Custom list of choices to send for the prompt. */ confirmChoices: (string | Choice)[] | undefined; /** * Creates a new ConfirmPrompt instance. * * @param dialogId Unique ID of the dialog within its parent {@link DialogSet} or {@link ComponentDialog}. * @param validator (Optional) validator that will be called each time the user responds to the prompt. * @param defaultLocale (Optional) locale to use if the `TurnContext.activity.locale` is not specified. Defaults to a value of `en-us`. * @param choiceDefaults (Optional) Overrides the dictionary of Default Choices on {@link PromptCultureModels.getSupportedCultures | PromptCultureModels.getSupportedCultures} method. */ constructor(dialogId: string, validator?: PromptValidator, defaultLocale?: string, choiceDefaults?: ChoiceDefaultsConfirmPrompt); /** * Prompts the user for input. * * @param context 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 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. */ protected onPrompt(context: TurnContext, state: any, options: PromptOptions, isRetry: boolean): Promise; /** * Attempts to recognize the user's input. * * @param context 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 object constructed * from the options initially provided in the call to Prompt. * @returns A `Promise` representing the asynchronous operation. */ protected onRecognize(context: TurnContext, _state: any, _options: PromptOptions): Promise>; /** * @private */ private determineCulture; }