SkillDialog class
Boîte de dialogue spécialisée qui peut encapsuler des appels distants à une compétence.
- Extends
-
Dialog<Partial<BeginSkillDialogOptions>>
Remarques
Le paramètre options dans beginDialog doit être une instance BeginSkillDialogOptions avec les paramètres initiaux de la boîte de dialogue.
Constructeurs
| Skill |
Exemple de boîte de dialogue qui peut encapsuler des appels distants à une compétence. |
Propriétés
| id | ID unique de la boîte de dialogue. Définit l’ID unique de la boîte de dialogue. |
| telemetry |
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. |
Propriétés héritées
| End |
Obtient un résultat de fin de tour par défaut. |
Méthodes
| begin |
Appelé lorsque la boîte de dialogue de compétence est démarrée et poussée vers la pile des dialogues. |
| continue |
Appelé lorsque la boîte de dialogue de compétence est poursuivie, où il s’agit du dialogue actif et où l’utilisateur répond avec une nouvelle activité. |
| end |
Appelé à la fin de la boîte de dialogue de compétence. |
| reprompt |
Appelé lorsque la boîte de dialogue de compétence doit réinviter l’utilisateur à entrer. |
| resume |
Appelé lorsqu’un dialogue de compétence enfant a terminé son tour, renvoyant le contrôle à ce dialogue. |
Méthodes héritées
| configure(Record<string, unknown>) | Méthode Fluent pour configurer l’objet. |
| get |
|
| get |
Chaîne encodée utilisée pour faciliter la détection des modifications de bot lors du redéploiement. |
| on |
Appelé lorsqu’un événement a été déclenché, à l’aide |
Détails du constructeur
SkillDialog(SkillDialogOptions, string)
Exemple de boîte de dialogue qui peut encapsuler des appels distants à une compétence.
new SkillDialog(dialogOptions: SkillDialogOptions, dialogId?: string)Paramètres
- dialogOptions
- SkillDialogOptions
Options permettant d’exécuter la boîte de dialogue de compétence.
- dialogId
-
string
ID de la boîte de dialogue.
Remarques
Le paramètre options dans beginDialog() doit être un SkillDialogArgs objet avec les paramètres initiaux de la boîte de dialogue.
Détails de la propriété
id
ID unique de la boîte de dialogue. Définit l’ID unique de la boîte de dialogue.
string idValeur de propriété
string
ID de la boîte de dialogue.
Remarques
Celui-ci est généré automatiquement s’il n’est pas spécifié.
telemetryClient
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 telemetryClientValeur de propriété
BotTelemetryClient
BotTelemetryClient à utiliser pour la journalisation.
Détails de la propriété héritée
EndOfTurn
Obtient un résultat de fin de tour par défaut.
static EndOfTurn: DialogTurnResultValeur 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é deDialog.EndOfTurn
Détails de la méthode
beginDialog(DialogContext, BeginSkillDialogOptions)
Appelé lorsque la boîte de dialogue de compétence est démarrée et poussée vers la pile des dialogues.
function beginDialog(dc: DialogContext, options: BeginSkillDialogOptions): Promise<DialogTurnResult>Paramètres
DialogContext pour le tour actuel de la conversation.
- options
- BeginSkillDialogOptions
Informations initiales à transmettre à la boîte de dialogue.
Retours
Promise<DialogTurnResult>
Promesse représentant l’opération asynchrone.
Remarques
Si la tâche réussit, le résultat indique si la boîte de dialogue est toujours active une fois que le tour a été traité par la boîte de dialogue.
continueDialog(DialogContext)
Appelé lorsque la boîte de dialogue de compétence est poursuivie, où il s’agit du dialogue actif et où l’utilisateur répond avec une nouvelle activité.
function continueDialog(dc: DialogContext): Promise<DialogTurnResult>Paramètres
DialogContext pour le tour actuel de la conversation.
Retours
Promise<DialogTurnResult>
Promesse représentant l’opération asynchrone.
Remarques
Si la tâche réussit, le résultat indique si la boîte de dialogue est toujours active une fois que le tour a été traité par la boîte de dialogue. Le résultat peut également contenir une valeur de retour.
endDialog(TurnContext, DialogInstance, DialogReason)
Appelé à la fin de la boîte de dialogue de compétence.
function endDialog(context: TurnContext, instance: DialogInstance, reason: DialogReason): Promise<void>Paramètres
- context
-
TurnContext
Objet TurnContext pour ce tour.
- instance
- DialogInstance
Informations d’état associées à l’instance de cette boîte de dialogue sur la pile des dialogues.
- reason
- DialogReason
(xref:botbuilder-dialogs. DialogReason) pourquoi le dialogue s’est terminé.
Retours
Promise<void>
Promesse représentant l’opération asynchrone.
repromptDialog(TurnContext, DialogInstance)
Appelé lorsque la boîte de dialogue de compétence doit réinviter l’utilisateur à entrer.
function repromptDialog(context: TurnContext, instance: DialogInstance): Promise<void>Paramètres
- context
-
TurnContext
Objet TurnContext pour ce tour.
- instance
- DialogInstance
Informations d’état pour cette boîte de dialogue.
Retours
Promise<void>
Promesse représentant l’opération asynchrone.
resumeDialog(DialogContext, DialogReason, any)
Appelé lorsqu’un dialogue de compétence enfant a terminé son tour, renvoyant le contrôle à ce dialogue.
function resumeDialog(dc: DialogContext, _reason: DialogReason, _result?: any): Promise<DialogTurnResult>Paramètres
DialogContext pour le tour actuel de la conversation.
- _reason
- DialogReason
(xref:botbuilder-dialogs. DialogReason) pourquoi le dialogue a repris.
- _result
-
any
Facultatif, valeur retournée à partir de la boîte de dialogue appelée. Le type de la valeur retournée dépend de la boîte de dialogue enfant.
Retours
Promise<DialogTurnResult>
Promesse représentant l’opération asynchrone.
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>): thisParamètres
- config
-
Record<string, unknown>
Paramètres de configuration à appliquer.
Retours
this
Configurable une fois l’opération terminée.
Hérité deConfigurable.configure
getConverter(string)
function getConverter(_property: string): Converter | ConverterFactoryParamètres
- _property
-
string
Clé de la configuration du sélecteur conditionnel.
Retours
Convertisseur pour la configuration du sélecteur.
Hérité deConfigurable.getConverter
getVersion()
Chaîne encodée utilisée pour faciliter la détection des modifications de bot lors du redéploiement.
function getVersion(): stringRetours
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é deDialog.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
Contexte de boîte de dialogue pour la tournure actuelle de la conversation.
É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é deDialog.onDialogEvent