ChoicePrompt class

Crée une instance ChoicePrompt.

new ChoicePrompt(dialogId: string, validator?: PromptValidator<FoundChoice>, defaultLocale?: string, choiceDefaults?: ChoiceDefaultsChoicePrompt)

Paramètres

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

choiceOptions: ChoiceFactoryOptions | undefined

Valeur de propriété

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

defaultLocale: string | undefined

Valeur de propriété

ID unique de la boîte de dialogue. Définit l’ID unique de la boîte de dialogue.

string id

Valeur de propriété

ID de la boîte de dialogue.

Remarques

Cette opération est générée automatiquement si elle n’est pas spécifiée.

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

recognizerOptions: FindChoicesOptions | undefined

Valeur de propriété

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

style: ListStyle

Valeur de propriété

Remarques

La valeur par défaut est ListStyle.auto.

Obtient le client de télémétrie pour cette boîte de dialogue. Définit le client de télémétrie pour cette boîte de dialogue.

BotTelemetryClient telemetryClient

Valeur de propriété

Le BotTelemetryClient à utiliser pour la journalisation.

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 dedialog.EndOfTurn

Appelé lorsqu’une boîte de dialogue d’invite est envoyée (push) sur la pile de dialogues et est activée.

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

Paramètres

Retours

Un Promise représentant l’opération asynchrone.

Remarques

Si la tâche réussit, le résultat indique si l’invite est toujours active une fois que le tour a été traité par l’invite.

héritée deprompt.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 deConfigurable.configure

Appelé lorsqu’une boîte de dialogue d’invite est la boîte de dialogue active et que l’utilisateur a répondu avec une nouvelle activité.

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

Paramètres

Retours

Un Promise représentant l’opération asynchrone.

Remarques

Si la tâche réussit, le résultat indique si la boîte de dialogue est toujours active une fois le tour traité par la boîte de dialogue. L’invite continue généralement de recevoir les réponses de l’utilisateur jusqu’à ce qu’elle accepte la réponse de l’utilisateur comme entrée valide pour l’invite.

héritée dePrompt.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 dedialog.endDialog

function getConverter(_property: string): Converter | ConverterFactory

Paramètres

Retours

Convertisseur de la configuration du sélecteur.

héritée deconfigurable.getConverter

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 deDialog.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 deDialog.onDialogEvent

Appelé lorsqu’une boîte de dialogue d’invite a été demandée pour inviter l’utilisateur à entrer à nouveau.

function repromptDialog(context: TurnContext, instance: DialogInstance): Promise<void>

Paramètres

Retours

Un Promise représentant l’opération asynchrone.

héritée deprompt.repromptDialog

Appelé lorsqu’une boîte de dialogue d’invite reprend la boîte de dialogue active sur la pile de dialogues, par exemple lorsque la boîte de dialogue active précédente sur la pile se termine.

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

Paramètres

Retours

Promesse représentant l’opération asynchrone.

Remarques

Si la tâche réussit, le résultat indique si la boîte de dialogue est toujours active une fois le tour traité par la boîte de dialogue.

héritée deprompt.resumeDialog