Dialog class
Définit le comportement principal de tous les dialogues.
- Extends
Constructeurs
| Dialog(string) | Crée une instance de la classe Dialog . |
Propriétés
| End |
Obtient un résultat de fin de tour par défaut. |
| id | ID unique de la boîte de dialogue. Définit l’ID unique de la boîte de dialogue. |
| telemetry |
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. |
Méthodes
| begin |
En cas de substitution dans une classe dérivée, démarre la boîte de dialogue. |
| continue |
En cas de substitution dans une classe dérivée, continue la boîte de dialogue. |
| end |
En cas de substitution dans une classe dérivée, effectue le nettoyage de la boîte de dialogue avant sa fin. |
| get |
Chaîne encodée utilisée pour faciliter la détection des modifications de bot lors du redéploiement. |
| on |
Appelé lorsqu’un événement a été déclenché, à l’aide |
| reprompt |
En cas de substitution dans une classe dérivée, réexpte l’utilisateur pour l’entrée. |
| resume |
En cas de substitution dans une classe dérivée, reprend la boîte de dialogue une fois la boîte de dialogue située au-dessus de celle-ci sur la pile terminée. |
Méthodes héritées
| configure(Record<string, unknown>) | Méthode Fluent pour configurer l’objet. |
| get |
Détails du constructeur
Dialog(string)
Crée une instance de la classe Dialog .
new Dialog(dialogId?: string)Paramètres
- dialogId
-
string
facultatif. ID unique de la boîte de dialogue.
Détails de la propriété
EndOfTurn
Obtient un résultat de fin de tour par défaut.
static EndOfTurn: DialogTurnResultValeur de propriété
Remarques
Ce résultat indique qu’un dialogue (ou une étape logique dans un dialogue) a terminé le traitement pour le tour actuel, est toujours actif et attend plus d’entrée.
id
ID unique de la boîte de dialogue. Définit l’ID unique de la boîte de dialogue.
string idValeur de propriété
string
Id de la boîte de dialogue.
Remarques
Celui-ci est automatiquement généré s’il n’est pas spécifié.
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 telemetryClientValeur de propriété
BotTelemetryClient
BotTelemetryClient à utiliser pour la journalisation.
Détails de la méthode
beginDialog(DialogContext, O)
En cas de substitution dans une classe dérivée, démarre la boîte de dialogue.
function beginDialog(dc: DialogContext, options?: O): Promise<DialogTurnResult>Paramètres
Contexte du tour de dialogue actuel.
- options
-
O
facultatif. Arguments à utiliser au démarrage de la boîte de dialogue.
Retours
Promise<DialogTurnResult>
Remarques
Les boîtes de dialogue dérivées doivent remplacer cette méthode.
DialogContext appelle cette méthode lorsqu’il crée une nouvelle boîte de dialogue DialogInstance, l’envoie dans la pile de dialogues et démarre la boîte de dialogue.
Un dialogue qui représente une conversation à tour unique doit attendre DialogContext.endDialog avant de quitter cette méthode.
Voir aussi
continueDialog(DialogContext)
En cas de substitution dans une classe dérivée, continue la boîte de dialogue.
function continueDialog(dc: DialogContext): Promise<DialogTurnResult>Paramètres
Contexte du tour de dialogue actuel.
Retours
Promise<DialogTurnResult>
Promesse résolvant le résultat du tour de boîte de dialogue.
Remarques
Les dialogues dérivés qui prennent en charge les conversations à plusieurs tours doivent remplacer cette méthode. Par défaut, cette méthode signale que la boîte de dialogue est terminée et retourne.
DialogContext appelle cette méthode lorsqu’il poursuit le dialogue.
Pour signaler au contexte de dialogue que ce dialogue est terminé, attendez DialogContext.endDialog avant de quitter cette méthode.
Voir aussi
endDialog(TurnContext, DialogInstance, DialogReason)
En cas de substitution dans une classe dérivée, effectue le nettoyage de la boîte de dialogue avant sa fin.
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 actuel pour cette boîte de dialogue.
- _reason
- DialogReason
Raison pour laquelle la boîte de dialogue se termine.
Retours
Promise<void>
Remarques
Les boîtes de dialogue dérivées qui doivent effectuer la journalisation ou le nettoyage avant de se terminer doivent remplacer cette méthode. Par défaut, cette méthode n’a aucun effet.
DialogContext appelle cette méthode lorsque le dialogue actuel se termine.
Voir aussi
getVersion()
Chaîne encodée utilisée pour faciliter la détection des modifications de bot lors du redéploiement.
function getVersion(): stringRetours
string
Chaîne unique qui ne doit changer que lorsque la boîte de dialogue a changé d’une manière qui doit redémarrer le dialogue.
Remarques
Cela renvoie par défaut l’ID de boîte de dialogue, mais peut être remplacé pour fournir une logique de détection des modifications plus précise. Toute boîte de dialogue sur la pile dont la version est modifiée entraîne la levée d’un versionChanged événement. 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 de version pour le composant.
onDialogEvent(DialogContext, DialogEvent)
Appelé lorsqu’un événement a été déclenché, à l’aide DialogContext.emitEvent()de , par la boîte de dialogue active ou par un dialogue que le dialogue actuel a démarré.
function onDialogEvent(dc: DialogContext, e: DialogEvent): Promise<boolean>Paramètres
Contexte de boîte de dialogue pour la tournure actuelle de la conversation.
Événement déclenché.
Retours
Promise<boolean>
True si l’événement est géré par la boîte de dialogue active et que le bouillonnement doit s’arrêter.
repromptDialog(TurnContext, DialogInstance)
En cas de substitution dans une classe dérivée, réexpte l’utilisateur pour l’entrée.
function repromptDialog(_context: TurnContext, _instance: DialogInstance): Promise<void>Paramètres
- _context
-
TurnContext
Objet de contexte pour le tour.
- _instance
- DialogInstance
Informations d’état actuel pour cette boîte de dialogue.
Retours
Promise<void>
Remarques
Les boîtes de dialogue dérivées qui prennent en charge la logique de validation et de nouvelle invite doivent remplacer cette méthode. Par défaut, cette méthode n’a aucun effet.
DialogContext appelle cette méthode lorsque la boîte de dialogue actuelle doit re-demander l’entrée à l’utilisateur. Cette méthode est implémentée pour les boîtes de dialogue d’invite.
Voir aussi
resumeDialog(DialogContext, DialogReason, any)
En cas de substitution dans une classe dérivée, reprend la boîte de dialogue une fois la boîte de dialogue située au-dessus de celle-ci sur la pile terminée.
function resumeDialog(dc: DialogContext, reason: DialogReason, result?: any): Promise<DialogTurnResult>Paramètres
Contexte du tour de dialogue actuel.
- reason
- DialogReason
Raison pour laquelle le dialogue reprend. Il s’agit généralement de DialogReason.endCalled
- result
-
any
facultatif. Valeur de retour, le cas échéant, de la boîte de dialogue qui s’est terminée.
Retours
Promise<DialogTurnResult>
Promesse résolvant le résultat du tour de dialogue.
Remarques
Les dialogues dérivés qui prennent en charge les conversations à plusieurs tours doivent remplacer cette méthode. Par défaut, cette méthode signale que la boîte de dialogue est terminée et retourne.
Le DialogContext appelle cette méthode lorsqu’il reprend la boîte de dialogue. Si la boîte de dialogue précédente sur la pile a retourné une valeur, cette valeur se trouve dans le result paramètre .
Pour démarrer un dialogue enfant , utilisez DialogContext.beginDialog ou DialogContext.prompt ; toutefois, ce dialogue ne sera pas nécessairement celui qui a démarré le dialogue enfant. Pour signaler au contexte de dialogue que ce dialogue est terminé, attendez DialogContext.endDialog avant de quitter cette méthode.
Voir aussi
Détails de la méthode héritée
configure(Record<string, unknown>)
Méthode Fluent pour configurer l’objet.
function configure(config: Record<string, unknown>): thisParamètres
- config
-
Record<string, unknown>
Paramètres de configuration à appliquer.
Retours
this
Configurable une fois l’opération terminée.
Hérité deConfigurable.configure
getConverter(string)
function getConverter(_property: string): Converter | ConverterFactoryParamètres
- _property
-
string
Clé de la configuration du sélecteur conditionnel.
Retours
Convertisseur pour la configuration du sélecteur.
Hérité deConfigurable.getConverter