BeginDialog class

Crée une instance BeginDialog.

new BeginDialog(dialogIdToCall: string, options?: O)

Paramètres

static $kind: string

Valeur de propriété

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

disabled?: BoolExpression

Valeur de propriété

(Facultatif) chemin de propriété pour stocker le résultat de la boîte de dialogue.

resultProperty?: StringExpression

Valeur de propriété

Valeur indiquant si la nouvelle boîte de dialogue doit traiter l’activité.

activityProcessed: BoolExpression

Valeur de propriété

héritée deBaseInvokeDialog.activityProcessed

Boîte de dialogue à appeler.

dialog: DialogExpression

Valeur de propriété

héritée deBaseInvokeDialog.dialog

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

Options configurables pour la boîte de dialogue.

options: ObjectExpression<object>

Valeur de propriété

héritée deBaseInvokeDialog.options

telemetryClient: BotTelemetryClient

Valeur de propriété

héritée de Dialog.telemetryClient

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

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

Paramètres

Retours

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

function getConverter(property: Object): Converter | ConverterFactory

Paramètres

Retours

Convertisseur de la configuration du sélecteur.

Appelé lorsqu’un dialogue enfant terminé son tour, renvoyant le contrôle à ce dialogue.

function resumeDialog(dc: DialogContext, reason: DialogReason, result?: any): Promise<DialogTurnResult>

Paramètres

Retours

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

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

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

héritée de Dialog.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

Obtient les dépendances boîte de dialogue enfant afin qu’elles puissent être ajoutées aux conteneurs dialogue set.

function getDependencies(): Dialog<__type>[]

Retours

Boîte de dialogue enfant dépendances.

héritée deBaseInvokeDialog.getDependencies

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