Dialog class

Crée une instance de la classe Dialog.

new Dialog(dialogId?: string)

Paramètres

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.

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.

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.

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

Retours

Remarques

Les dialogues dérivés doivent remplacer cette méthode.

Le DialogContext appelle cette méthode lorsqu’elle crée une nouvelle DialogInstance pour ce dialogue, l’envoie (push) dans la pile de dialogues et démarre la boîte de dialogue.

Une boîte de dialogue qui représente une conversation à tour unique doit attendre DialogContext.endDialog avant de quitter cette méthode.

Voir également

• DialogContext.beginDialog
• DialogContext.replaceDialog

En cas de substitution dans une classe dérivée, poursuit la boîte de dialogue.

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

Paramètres

Retours

Promesse de résolution du 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’elle poursuit la boîte de dialogue.

Pour signaler au contexte de dialogue que ce dialogue est terminé, attendez DialogContext.endDialog avant de quitter cette méthode.

Voir également

• DialogContext.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

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.

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.

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

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

Retours

Promesse de résolution du 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.

La DialogContext appelle cette méthode lorsqu’elle 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 paramètre result.

Pour démarrer une boîte de dialogue de 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 également

• DialogContext.endDialog

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

function getConverter(_property: string): Converter | ConverterFactory

Paramètres

Retours

Convertisseur de la configuration du sélecteur.

héritée deconfigurable.getConverter