ChoiceInput class

Initialise une nouvelle instance de la classe InputDialog

new ChoiceInput(property?: string, prompt?: Partial<Activity> | string)

Paramètres

static $kind: string

Valeur de propriété

Options supplémentaires passées à l'ChoiceFactory et utilisées pour ajuster le style de choix rendu à l’utilisateur.

choiceOptions?: ObjectExpression<ChoiceFactoryOptions>

Valeur de propriété

Liste des choix à présenter à l’utilisateur.

choices: ObjectExpression<ChoiceSet>

Valeur de propriété

Les paramètres régionaux par défaut doivent être reconnus.

defaultLocale?: StringExpression

Valeur de propriété

Contrôlez le format de la réponse (valeur ou index du choix).

outputFormat: EnumExpression<ChoiceOutputFormat>

Valeur de propriété

Options supplémentaires passées à la fonction recognizeChoices() sous-jacente.

recognizerOptions?: ObjectExpression<FindChoicesOptions>

Valeur de propriété

Style des choix « oui » et « non » rendus à l’utilisateur lors de l’invite.

style: EnumExpression<ListStyle>

Valeur de propriété

Remarques

La valeur par défaut est ListStyle.auto.

Stratégie d’interruption.

allowInterruptions: BoolExpression

Valeur de propriété

héritée deInputDialog.allowInterruptions

Valeur indiquant si l’entrée doit toujours inviter l’utilisateur, qu’il y ait une valeur ou non.

alwaysPrompt: BoolExpression

Valeur de propriété

héritée deInputDialog.alwaysPrompt

Valeur par défaut de la boîte de dialogue d’entrée lorsque maxTurnCount est dépassé.

defaultValue?: ValueExpression

Valeur de propriété

héritée deInputDialog.defaultValue

Modèle d’activité à envoyer lorsque maxTurnCount a été atteint et que la valeur par défaut est utilisée.

defaultValueResponse: TemplateInterface<Partial<Activity>, DialogStateManager>

Valeur de propriété

héritée deInputDialog.defaultValueResponse

Expression facultative qui, si la valeur est true, désactive cette action.

disabled?: BoolExpression

Valeur de propriété

héritée deInputDialog.disabled

Obtient un résultat de fin de tour par défaut.

static EndOfTurn: DialogTurnResult

Valeur de propriété

Remarques

Ce résultat indique qu’un dialogue (ou une étape logique dans un dialogue) a terminé le traitement du tour actuel, est toujours actif et attend plus d’entrée.

héritée de Dialog.EndOfTurn

id: string

Valeur de propriété

héritée de Dialog.id

Modèle d’activité à envoyer à l’utilisateur chaque fois que la valeur fournie n’est pas valide ou non.

invalidPrompt: TemplateInterface<Partial<Activity>, DialogStateManager>

Valeur de propriété

héritée deInputDialog.invalidPrompt

Nombre maximal de fois où demander à l’utilisateur cette valeur avant la fin de la boîte de dialogue.

maxTurnCount?: IntExpression

Valeur de propriété

héritée deInputDialog.maxTurnCount

static OPTIONS_PROPERTY: string

Valeur de propriété

héritée deInputDialog.OPTIONS_PROPERTY

Activité à envoyer à l’utilisateur.

prompt: TemplateInterface<Partial<Activity>, DialogStateManager>

Valeur de propriété

héritée deInputDialog.prompt

Expression de valeur à laquelle l’entrée sera liée.

property: StringExpression

Valeur de propriété

héritée deInputDialog.property

telemetryClient: BotTelemetryClient

Valeur de propriété

héritée de Dialog.telemetryClient

static TURN_COUNT_PROPERTY: string

Valeur de propriété

héritée deInputDialog.TURN_COUNT_PROPERTY

Modèle d’activité pour l’invite de nouvelles tentatives.

unrecognizedPrompt: TemplateInterface<Partial<Activity>, DialogStateManager>

Valeur de propriété

héritée deInputDialog.unrecognizedPrompt

Expressions à exécuter pour valider l’entrée.

validations: string[]

Valeur de propriété

héritée deInputDialog.validations

Expression de valeur qui peut être utilisée pour initialiser l’invite d’entrée.

value: ValueExpression

Valeur de propriété

héritée deInputDialog.value

static VALUE_PROPERTY: string

Valeur de propriété

héritée deInputDialog.VALUE_PROPERTY

function getConverter(property: Object): Converter | ConverterFactory

Paramètres

Retours

Convertisseur de la configuration du sélecteur.

Appelé lorsque le de dialogue est démarré et envoyé (push) sur la pile de dialogues.

function beginDialog(dc: DialogContext, options?: any): Promise<DialogTurnResult>

Paramètres

Retours

DialogTurnResultPromise représentant l’opération asynchrone.

héritée deInputDialog.beginDialog

Méthode Fluent pour la configuration de l’objet.

function configure(config: Record<string, unknown>): this

Paramètres

Retours

configurable une fois l’opération terminée.

héritée de Configurable.configure

Appelé lorsque le dialogue est continu, où il s’agit du dialogue actif et que l’utilisateur répond avec une nouvelle activité.

function continueDialog(dc: DialogContext): Promise<DialogTurnResult>

Paramètres

Retours

DialogTurnResultPromise représentant l’opération asynchrone.

héritée deInputDialog.continueDialog

En cas de substitution dans une classe dérivée, effectue le nettoyage de la boîte de dialogue avant de se terminer.

function endDialog(_context: TurnContext, _instance: DialogInstance, _reason: DialogReason): Promise<void>

Paramètres

Retours

Remarques

Les dialogues dérivés qui doivent effectuer la journalisation ou le nettoyage avant la fin doivent remplacer cette méthode. Par défaut, cette méthode n’a aucun effet.

Le DialogContext appelle cette méthode lorsque le dialogue actuel se termine.

Voir également

• DialogContext.cancelAllDialogs
• DialogContext.endDialog
• DialogContext.replaceDialog

héritée de Dialog.endDialog

Chaîne encodée utilisée pour faciliter la détection des modifications de bot lors du rééploiement.

function getVersion(): string

Retours

Chaîne unique qui ne doit changer que lorsque la boîte de dialogue a changé de manière à redémarrer la boîte de dialogue.

Remarques

Cela permet par défaut de retourner les dialogues id, mais peut être substitué pour fournir une logique de détection des modifications plus précise. Toute boîte de dialogue sur la pile qui a sa modification de version entraîne un événement versionChanged sera déclenché. Si cet événement n’est pas géré par le bot, une erreur est générée, ce qui entraîne l’exécution de la logique du gestionnaire d’erreurs des bots.

Le renvoi d’une chaîne vide désactive le suivi des versions pour le composant tous ensemble.

héritée de Dialog.getVersion

Appelé lorsqu’un événement a été déclenché, à l’aide de DialogContext.emitEvent(), par la boîte de dialogue active ou par une boîte de dialogue que la boîte de dialogue active a démarré.

function onDialogEvent(dc: DialogContext, e: DialogEvent): Promise<boolean>

Paramètres

Retours

True si l’événement est géré par la boîte de dialogue actuelle et que le bouglage doit s’arrêter.

héritée de Dialog.onDialogEvent

En cas de substitution dans une classe dérivée, repromène l’utilisateur pour l’entrée.

function repromptDialog(_context: TurnContext, _instance: DialogInstance): Promise<void>

Paramètres

Retours

Remarques

Les dialogues dérivés qui prennent en charge la validation et la logique de nouvelle invite doivent remplacer cette méthode. Par défaut, cette méthode n’a aucun effet.

Le DialogContext appelle cette méthode lorsque la boîte de dialogue active doit demander à nouveau l’entrée de l’utilisateur. Cette méthode est implémentée pour les dialogues d’invite.

Voir également

• DialogContext.repromptDialog
• invite

héritée de Dialog.repromptDialog

Appelé lorsqu’un dialogue enfant termine son tour, en retournant le contrôle à ce dialogue.

function resumeDialog(dc: DialogContext, _reason: DialogReason, _result?: any): Promise<DialogTurnResult>

Paramètres

Retours

DialogTurnResultPromise représentant l’opération asynchrone.

héritée deInputDialog.resumeDialog