Partager via

CodeAction class

  • Référence
Paquet:
botbuilder-dialogs-adaptive

Classe représentant une action de code de dialogue .

Extends

Dialog<O>

Constructeurs

CodeAction(CodeActionHandler)

Initialise une nouvelle instance de la classe CodeAction .

Propriétés

disabled

Propriétés héritées

EndOfTurn

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

Méthodes

beginDialog(DialogContext, O)

Appelé lorsque la boîte de dialogue est démarrée et poussée dans la pile de dialogues.
getConverter(Object)

Méthodes héritées

configure(Record<string, unknown>)

Méthode Fluent pour configurer l’objet.
continueDialog(DialogContext)

En cas de substitution dans une classe dérivée, continue la boîte de dialogue.
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.
getVersion()

Chaîne encodée utilisée pour faciliter la détection des modifications de bot lors du redéploiement.
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é.
repromptDialog(TurnContext, DialogInstance)

En cas de substitution dans une classe dérivée, réexpte l’utilisateur pour l’entrée.
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.

Détails du constructeur

CodeAction(CodeActionHandler)

Initialise une nouvelle instance de la classe CodeAction .

new CodeAction(codeHandler: CodeActionHandler)

Paramètres

codeHandler
CodeActionHandler

(xref:botbuilder-dialogs-adaptive. CodeActionHandler), gestionnaire de code pour l’action.

Détails de la propriété

disabled 

disabled?: BoolExpression

Valeur de propriété

BoolExpression

Détails de la propriété héritée

EndOfTurn

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

static EndOfTurn: DialogTurnResult

Valeur de propriété

DialogTurnResult

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 

id: string

Valeur de propriété

string

Hérité de Dialog.id

telemetryClient 

telemetryClient: BotTelemetryClient

Valeur de propriété

BotTelemetryClient

Hérité de Dialog.telemetryClient

Détails de la méthode

beginDialog(DialogContext, O)

Appelé lorsque la boîte de dialogue est démarrée et poussée dans la pile de dialogues.

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

Paramètres

dc

DialogContext

DialogContext pour le tour actuel de la conversation.

options

O

facultatif. Informations initiales à transmettre à la boîte de dialogue.

Retours

Promise<DialogTurnResult>

Promise représentant l’opération asynchrone.

getConverter(Object) 

function getConverter(property: Object): Converter | ConverterFactory

Paramètres

property

Object

Clé de la configuration du sélecteur conditionnel.

Retours

Converter | ConverterFactory

Convertisseur pour la configuration du sélecteur.

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>): this

Paramètres

config

Record<string, unknown>

Paramètres de configuration à appliquer.

Retours

this

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

Hérité de Configurable.configure

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

dc

DialogContext

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

Hérité de Dialog.continueDialog

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

Hérité de Dialog.endDialog

getVersion()

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

function getVersion(): string

Retours

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.

Hérité de Dialog.getVersion

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

dc

DialogContext

Contexte de boîte de dialogue pour la tournure actuelle de la conversation.

e

DialogEvent

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

Hérité de Dialog.onDialogEvent

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

Hérité de Dialog.repromptDialog

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

dc

DialogContext

Contexte du tour de dialogue actuel.

reason

DialogReason

Raison pour laquelle la boîte de 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 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

Hérité de Dialog.resumeDialog