WaterfallStepContext class

Crée une instance WaterfallStepContext.

new WaterfallStepContext(dc: DialogContext, info: WaterfallStepInfo<O>)

Paramètres

DialogInstance | undefined activeDialog

Valeur de propriété

Informations d’état pour la boîte de dialogue en haut de la pile de dialogues ou undefined si la pile est vide.

DialogContext | undefined child

Valeur de propriété

Contexte de boîte de dialogue pour enfant si le dialogue actif est un conteneur.

DialogManager dialogManager

Valeur de propriété

Instance actuelle du gestionnaire de dialogues. Cette propriété est déconseillée.

Index de l’étape en cascade en cours d’exécution.

number index

Valeur de propriété

Index de l’étape en cascade en cours d’exécution.

Toutes les options passées au dialogue en cascade des étapes lorsqu’elle a été démarrée avec DialogContext.beginDialog().

O options

Valeur de propriété

Toutes les options avec le dialogue en cascade ont été appelées.

La raison pour laquelle l’étape en cascade est exécutée.

DialogReason reason

Valeur de propriété

La raison pour laquelle l’étape en cascade est exécutée.

Résultats retournés par une boîte de dialogue ou une invite qui a été appelée à l’étape précédente en cascade.

any result

Valeur de propriété

Résultat de l’étape précédente en cascade.

Dictionnaire de valeurs qui seront conservées dans toutes les étapes en cascade.

object values

Valeur de propriété

Dictionnaire de valeurs qui seront conservées dans toutes les étapes en cascade.

Obtient l’objet de contexte pour le tour.

context: TurnContext

Valeur de propriété

héritée dedialogContext.context

Obtient les dialogues qui peuvent être appelés directement à partir de ce contexte.

dialogs: DialogSet

Valeur de propriété

héritée deDialogContext.dialogs

Contexte de dialogue parent pour ce contexte de dialogue ou undefined si ce contexte n’a pas de parent.

parent: DialogContext | undefined

Valeur de propriété

Remarques

Lorsqu’il tente de démarrer un dialogue, le contexte de dialogue recherche le Dialog.id dans ses dialogues . Si la boîte de dialogue à démarrer est introuvable dans ce contexte de dialogue, elle recherche dans son contexte de dialogue parent, et ainsi de suite.

héritée dedialogContext.parent

Obtient la collection de services contextuelle à ce contexte de dialogue.

services: TurnContextStateCollection

Valeur de propriété

héritée dedialogContext.services

Obtient la pile de dialogues actuelle.

stack: DialogInstance[]

Valeur de propriété

héritée dedialogContext.stack

Obtient le DialogStateManager qui gère l’affichage de toutes les étendues de mémoire.

state: DialogStateManager

Valeur de propriété

héritée dedialogContext.state

Passe à l’étape en cascade suivante.

function next(result?: any): Promise<DialogTurnResult>

Paramètres

Retours

Promesse avec dialogTurnResult.

Remarques

return await step.skip();

Démarre une instance de dialogue et l’envoie (push) sur la pile de dialogues. Crée une instance de la boîte de dialogue et l’envoie (push) sur la pile.

function beginDialog(dialogId: string, options?: object): Promise<DialogTurnResult>

Paramètres

Retours

une promesse de résolution du résultat du tour de dialogue.

Remarques

S’il existe déjà un dialogue actif sur la pile, ce dialogue sera suspendu jusqu’à ce qu’il soit à nouveau le dialogue supérieur de la pile.

L’état de l’objet retourné décrit l’état de la pile de dialogues une fois cette méthode terminée.

Cette méthode lève une exception si le dialogue demandé est introuvable dans ce contexte de dialogue ou dans l’un de ses ancêtres.

Par exemple:

const result = await dc.beginDialog('greeting', { name: user.name });

Voir également

• endDialog
• prompt
• replaceDialog
• Dialog.beginDialog

héritée deDialogContext.beginDialog

Annule tous les dialogues de la pile de dialogues et efface la pile.

function cancelAllDialogs(cancelParents?: boolean, eventName?: string, eventValue?: any): Promise<DialogTurnResult>

Paramètres

Retours

une promesse de résolution du résultat du tour de dialogue.

Remarques

Cela appelle la méthode Dialog.endDialog de chaque dialogue avant de supprimer le dialogue de la pile.

S’il y avait des dialogues sur la pile initialement, l’état de la valeur de retour est annulé; sinon, il est vide.

Cet exemple efface une pile de dialogues, dc, avant de démarrer une boîte de dialogue « bookFlight ».

await dc.cancelAllDialogs();
return await dc.beginDialog('bookFlight');

Voir également

• endDialog

héritée deDialogContext.cancelAllDialogs

Poursuit l’exécution du dialogue actif, s’il en existe un, en transmettant ce contexte de dialogue à sa méthode Dialog.continueDialog.

function continueDialog(): Promise<DialogTurnResult>

Retours

une promesse de résolution du résultat du tour de dialogue.

Remarques

Une fois l’appel terminé, vous pouvez vérifier l'du contexte de tour a répondu propriété pour déterminer si la boîte de dialogue a envoyé une réponse à l’utilisateur.

L’état de l’objet retourné décrit l’état de la pile de dialogues une fois cette méthode terminée.

En règle générale, vous appelez cela à partir du gestionnaire de tour de votre bot.

Par exemple:

const result = await dc.continueDialog();
if (result.status == DialogTurnStatus.empty && dc.context.activity.type == ActivityTypes.message) {
    // Send fallback message
    await dc.context.sendActivity(`I'm sorry. I didn't understand.`);
}

héritée deDialogContext.continueDialog

Recherche une boîte de dialogue avec un ID donné.

function emitEvent(name: string, value?: any, bubble?: boolean, fromLeaf?: boolean): Promise<boolean>

Paramètres

Retours

true si l’événement a été géré.

Remarques

Émet un événement nommé pour la boîte de dialogue active, ou une personne qui l’a démarrée, pour gérer.

héritée deDialogContext.emitEvent

Termine une boîte de dialogue et l’affiche hors de la pile. Retourne un résultat facultatif au parent du dialogue.

function endDialog(result?: any): Promise<DialogTurnResult>

Paramètres

Retours

une promesse de résolution du résultat du tour de dialogue.

Remarques

Le dialogue parent est le dialogue suivant de la pile de dialogues, s’il en existe un. Cette méthode appelle la méthode Dialog.resumeDialog du parent, en passant le résultat retourné par la boîte de dialogue de fin. S’il n’existe aucune boîte de dialogue parente, le tour se termine et le résultat est disponible pour le bot via le résultat de l’objet retourné propriété.

L’état de l’objet retourné décrit l’état de la pile de dialogues une fois cette méthode terminée.

En règle générale, vous devez appeler cela dans la logique d’un dialogue spécifique pour signaler au contexte de dialogue que le dialogue a terminé, le dialogue doit être supprimé de la pile et le dialogue parent doit reprendre.

Par exemple:

return await dc.endDialog(returnValue);

Voir également

• beginDialog
• replaceDialog
• dialog.endDialog

héritée deDialogContext.endDialog

Recherche une boîte de dialogue avec un ID donné.

function findDialog(dialogId: string): Dialog | undefined

Paramètres

Retours

Boîte de dialogue de l’ID fourni.

Remarques

Si la boîte de dialogue à démarrer est introuvable dans le DialogSet associée à ce contexte de dialogue, elle tente de trouver le dialogue dans son contexte de dialogue parent.

Voir également

• boîtes de dialogue
• parent

héritée dedialogContext.findDialog

Obtenez cultureInfo dans DialogContext.

function getLocale(): string

Retours

chaîne de paramètres régionaux.

héritée deDialogContext.getLocale

Fonction d’assistance pour simplifier la mise en forme des options d’appel d’une boîte de dialogue d’invite.

function prompt(dialogId: string, promptOrOptions: string | Partial<Activity> | PromptOptions): Promise<DialogTurnResult>

Paramètres

Retours

Remarques

Cette méthode d’assistance met en forme l’objet à utiliser comme paramètre options, puis appelle beginDialog pour démarrer la boîte de dialogue d’invite spécifiée.

return await dc.prompt('confirmPrompt', `Are you sure you'd like to quit?`);

héritée deDialogContext.prompt

Fonction d’assistance pour simplifier la mise en forme des options d’appel d’une boîte de dialogue d’invite.

function prompt(dialogId: string, promptOrOptions: string | Partial<Activity> | PromptOptions, choices: string | Choice[]): Promise<DialogTurnResult>

Paramètres

Retours

Remarques

Cette méthode d’assistance met en forme l’objet à utiliser comme paramètre options, puis appelle beginDialog pour démarrer la boîte de dialogue d’invite spécifiée.

return await dc.prompt('confirmPrompt', `Are you sure you'd like to quit?`);

héritée deDialogContext.prompt

Termine le dialogue actif et démarre un nouveau dialogue à sa place.

function replaceDialog(dialogId: string, options?: object): Promise<DialogTurnResult>

Paramètres

Retours

une promesse de résolution du résultat du tour de dialogue.

Remarques

Cela est particulièrement utile pour créer une boucle ou rediriger vers un autre dialogue.

L’état de l’objet retourné décrit l’état de la pile de dialogues une fois cette méthode terminée.

Cette méthode est similaire à la fin du dialogue actuel et commence immédiatement la nouvelle. Toutefois, la boîte de dialogue parente n’est ni reprise ni avertie.

Voir également

• beginDialog
• endDialog

héritée deDialogContext.replaceDialog

Demande à l’utilisateur de réinscrire l’entrée dans la boîte de dialogue active.

function repromptDialog(): Promise<void>

Retours

Remarques

Cela appelle la méthode repromptDialog du dialogue actif.

Par exemple:

await dc.repromptDialog();

héritée deDialogContext.repromptDialog