Case class
Cas d’étendue d’action.
- Extends
Constructeurs
Case(string, Dialog[]) | Initialise une nouvelle instance de la classe Case |
Propriétés
value | Obtient ou définit l’expression de valeur à comparer par rapport à la condition. |
Propriétés héritées
actions | Actions à exécuter. |
End |
Obtient un résultat de fin de tour par défaut. |
id | |
telemetry |
Méthodes héritées
begin |
Appelé lorsque le de dialogue |
configure(Record<string, unknown>) | Méthode Fluent pour la configuration de l’objet. |
continue |
Appelé lorsque le dialogue est continu, où il s’agit du dialogue actif et que l’utilisateur répond avec une nouvelle activité. |
end |
En cas de substitution dans une classe dérivée, effectue le nettoyage de la boîte de dialogue avant de se terminer. |
get |
|
get |
Obtient les dépendances boîte de dialogue enfant afin qu’elles puissent être ajoutées aux conteneurs dialogue set. |
get |
Obtient une |
on |
Appelé lorsqu’un événement a été déclenché, à l’aide de |
reprompt |
En cas de substitution dans une classe dérivée, repromène l’utilisateur pour l’entrée. |
resume |
Appelé lorsqu’un dialogue enfant terminé son tour, renvoyant le contrôle à ce dialogue. |
Détails du constructeur
Case(string, Dialog[])
Initialise une nouvelle instance de la classe Case
new Case(value?: string, actions?: Dialog[])
Paramètres
- value
-
string
Optionnel. Valeur de chaîne de case.
- actions
-
Dialog[]
Optionnel. Liste numérique des actions de boîte de dialogue.
Détails de la propriété
value
Obtient ou définit l’expression de valeur à comparer par rapport à la condition.
value: string
Valeur de propriété
string
Détails de la propriété héritée
actions
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’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
id: string
Valeur de propriété
string
héritée de Dialog.id
telemetryClient
telemetryClient: BotTelemetryClient
Valeur de propriété
BotTelemetryClient
héritée de Dialog.telemetryClient
Détails de la méthode héritée
beginDialog(DialogContext, O)
Appelé lorsque le de dialogue
function beginDialog(dc: DialogContext, _options?: O): Promise<DialogTurnResult>
Paramètres
- dc
-
DialogContext
DialogContext pour le tour de conversation actuel.
- _options
-
O
Optionnel. Informations initiales à transmettre à la boîte de dialogue.
Retours
Promise<DialogTurnResult>
Un Promise
représentant l’opération asynchrone.
héritée deActionScope.beginDialog
configure(Record<string, unknown>)
Méthode Fluent pour la configuration de 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ée de Configurable.configure
continueDialog(DialogContext)
Appelé lorsque le dialogue est continu, où il s’agit du dialogue actif et que l’utilisateur répond avec une nouvelle activité.
function continueDialog(dc: DialogContext): Promise<DialogTurnResult>
Paramètres
- dc
-
DialogContext
DialogContext pour le tour de conversation actuel.
Retours
Promise<DialogTurnResult>
Un Promise
représentant l’opération asynchrone.
héritée deActionScope.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 de se terminer.
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 actuelles pour cette boîte de dialogue.
- _reason
-
DialogReason
Raison pour laquelle la boîte de dialogue se termine.
Retours
Promise<void>
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
getConverter(Object)
function getConverter(property: Object): Converter | ConverterFactory
Paramètres
- property
-
Object
Clé de la configuration du sélecteur conditionnel.
Retours
Converter | ConverterFactory
Convertisseur de la configuration du sélecteur.
héritée deActionScope.getConverter
getDependencies()
Obtient les dépendances boîte de dialogue enfant afin qu’elles puissent être ajoutées aux conteneurs dialogue set.
function getDependencies(): Dialog[]
Retours
Dialog[]
Boîte de dialogue enfant dépendances.
héritée deActionScope.getDependencies
getVersion()
Obtient une string
unique qui représente la version de cette boîte de dialogue. Si la version change entre les tours, le système de dialogue émet un événement DialogChanged.
function getVersion(): string
Retours
string
Unique string
qui ne doit changer que lorsque la boîte de dialogue a changé de manière à redémarrer la boîte de dialogue.
héritée deActionScope.getVersion
onDialogEvent(DialogContext, DialogEvent)
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
- dc
-
DialogContext
Contexte de boîte de dialogue pour le tour de conversation actuel.
- e
-
DialogEvent
Événement déclenché.
Retours
Promise<boolean>
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
repromptDialog(TurnContext, DialogInstance)
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
- _context
-
TurnContext
Objet de contexte pour le tour.
- _instance
-
DialogInstance
Informations d’état actuelles pour cette boîte de dialogue.
Retours
Promise<void>
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
héritée de Dialog.repromptDialog
resumeDialog(DialogContext, DialogReason, any)
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
- dc
-
DialogContext
DialogContext pour le tour de conversation actuel.
- _reason
-
DialogReason
(xref :botbuilder-dialogs. DialogReason), raison pour laquelle le dialogue a repris.
- result
-
any
Optionnel. Valeur retournée par la boîte de dialogue qui a été appelée. Le type de la valeur retournée dépend de la boîte de dialogue enfant.
Retours
Promise<DialogTurnResult>
Un Promise
représentant l’opération asynchrone.
héritée deActionScope.resumeDialog