Partager via

ChoicePrompt class

  • Référence
Paquet:
botbuilder-dialogs

Invite un utilisateur à sélectionner dans une liste de choix.

Extends

Prompt<FoundChoice>

Remarques

Par défaut, l’invite retourne à la boîte de dialogue appelante un objet FoundChoice contenant le choix sélectionné.

Constructeurs

ChoicePrompt(string, PromptValidator<FoundChoice>, string, ChoiceDefaultsChoicePrompt)

Crée une instance ChoicePrompt.

Propriétés

choiceOptions

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

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

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

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

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

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.

Propriétés héritées

EndOfTurn

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

Méthodes héritées

beginDialog(DialogContext, PromptOptions)

Appelé lorsqu’une boîte de dialogue d’invite est envoyée (push) sur la pile de dialogues et est activée.
configure(Record<string, unknown>)

Méthode Fluent pour la configuration de l’objet.
continueDialog(DialogContext)

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é.
endDialog(TurnContext, DialogInstance, DialogReason)

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

Chaîne encodée utilisée pour faciliter la détection des modifications de bot lors du rééploiement.
onDialogEvent(DialogContext, DialogEvent)

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é.
repromptDialog(TurnContext, DialogInstance)

Appelé lorsqu’une boîte de dialogue d’invite a été demandée pour inviter l’utilisateur à entrer à nouveau.
resumeDialog(DialogContext, DialogReason, any)

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.

Détails du constructeur

ChoicePrompt(string, PromptValidator<FoundChoice>, string, ChoiceDefaultsChoicePrompt)

Crée une instance ChoicePrompt.

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

Paramètres

dialogId

string

ID unique de la boîte de dialogue dans son DialogSetparent .

validator

PromptValidator<FoundChoice>

(Facultatif) validateur qui sera appelé chaque fois que l’utilisateur répond à l’invite. Si le validateur répond avec un message, aucune invite de nouvelle tentative supplémentaire n’est envoyée.

defaultLocale

string

(Facultatif) paramètres régionaux à utiliser si dc.context.activity.locale non spécifié. La valeur par défaut est en-us.

choiceDefaults
ChoiceDefaultsChoicePrompt

(Facultatif) Remplace le dictionnaire des _choiceDefaults pris en charge par le Kit de développement logiciel (SDK) Bot Framework (pour la localisation d’invite). Doit être transmis à chaque ConfirmPrompt qui a besoin des valeurs par défaut du choix personnalisé.

Détails de la propriété

choiceOptions

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é

ChoiceFactoryOptions | undefined

defaultLocale

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

defaultLocale: string | undefined

Valeur de propriété

string | undefined

id

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é

string

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.

recognizerOptions

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

recognizerOptions: FindChoicesOptions | undefined

Valeur de propriété

FindChoicesOptions | undefined

style

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

style: ListStyle

Valeur de propriété

ListStyle

Remarques

La valeur par défaut est ListStyle.auto.

telemetryClient

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é

BotTelemetryClient

Le BotTelemetryClient à utiliser pour la journalisation.

Détails de la propriété héritée

EndOfTurn

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

static EndOfTurn: DialogTurnResult

Valeur de propriété

DialogTurnResult

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

Détails de la méthode héritée

beginDialog(DialogContext, PromptOptions)

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

dc
DialogContext

DialogContext pour le tour actuel de la conversation.

options
PromptOptions

Optionnel. PromptOptions, informations supplémentaires à transmettre à l’invite en cours de démarrage.

Retours

Promise<DialogTurnResult>

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

configure(Record<string, unknown>)

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

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

Paramètres

config

Record<string, unknown>

Paramètres de configuration à appliquer.

Retours

this

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

héritée deConfigurable.configure

continueDialog(DialogContext)

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

dc
DialogContext

DialogContext pour le tour de conversation actuel.

Retours

Promise<DialogTurnResult>

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

endDialog(TurnContext, DialogInstance, DialogReason)

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

_context

TurnContext

Objet de contexte pour le tour.

_instance
DialogInstance

Informations d’état actuelles pour cette boîte de dialogue.

_reason
DialogReason

Raison pour laquelle la boîte de dialogue se termine.

Retours

Promise<void>

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

héritée dedialog.endDialog

getConverter(string) 

function getConverter(_property: string): Converter | ConverterFactory

Paramètres

_property

string

Clé de la configuration du sélecteur conditionnel.

Retours

Converter | ConverterFactory

Convertisseur de la configuration du sélecteur.

héritée deconfigurable.getConverter

getVersion()

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

function getVersion(): string

Retours

string

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

onDialogEvent(DialogContext, DialogEvent)

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

dc
DialogContext

Contexte de boîte de dialogue pour le tour de conversation actuel.

e
DialogEvent

Événement déclenché.

Retours

Promise<boolean>

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

repromptDialog(TurnContext, DialogInstance)

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

context

TurnContext

(xref :botbuilder-core. TurnContext), contexte pour le tour de conversation actuel avec l’utilisateur.

instance
DialogInstance

(xref :botbuilder-dialogs. DialogInstance), instance du dialogue sur la pile.

Retours

Promise<void>

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

héritée deprompt.repromptDialog

resumeDialog(DialogContext, DialogReason, any)

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

dc
DialogContext

DialogContext pour le tour actuel de la conversation.

_reason
DialogReason

Énumération indiquant pourquoi le dialogue a repris.

_result

any

Facultatif, valeur retournée par la boîte de dialogue précédente sur la pile. Le type de la valeur retournée dépend de la boîte de dialogue précédente.

Retours

Promise<DialogTurnResult>

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