SetProperties class

new SetProperties()

static $kind: string

Valeur de propriété

Paramètres de propriété supplémentaires en tant que paires propriété/valeur.

assignments: PropertyAssignment[]

Valeur de propriété

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

disabled?: BoolExpression

Valeur de propriété

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

static EndOfTurn: DialogTurnResult

Valeur de propriété

Remarques

Ce résultat indique qu’une boîte de dialogue (ou une étape logique au sein d’un dialogue) a terminé le traitement pour le tour en cours, qu’elle est toujours active et qu’elle attend davantage d’entrée.

Hérité de Dialog.EndOfTurn

id: string

Valeur de propriété

Hérité de Dialog.id

telemetryClient: BotTelemetryClient

Valeur de propriété

Hérité de Dialog.telemetryClient

Démarre une nouvelle boîte de dialogue et l’envoie dans la pile des dialogues.

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

Paramètres

Retours

Promise représentant l’opération asynchrone.

function getConverter(property: Object): Converter | ConverterFactory

Paramètres

Retours

Convertisseur pour la configuration du sélecteur.

Méthode Fluent pour configurer l’objet.

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

Paramètres

Retours

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

Hérité de Configurable.configure

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

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

Paramètres

Retours

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

• DialogContext.continueDialog

Hérité de Dialog.continueDialog

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

Retours

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

• DialogContext.cancelAllDialogs
• DialogContext.endDialog
• DialogContext.replaceDialog

Hérité de Dialog.endDialog

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

function getVersion(): string

Retours

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.

Hérité de Dialog.getVersion

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

Retours

True si l’événement est géré par la boîte de dialogue active et que le bouillonnement doit s’arrêter.

Hérité de Dialog.onDialogEvent

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

Retours

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

• DialogContext.repromptDialog
• Demander

Hérité de Dialog.repromptDialog

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

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

• DialogContext.endDialog

Hérité de Dialog.resumeDialog