ForEach class

Initialise une nouvelle instance de la classe Foreach.

new ForEach()

Initialise une nouvelle instance de la classe Foreach.

new ForEach(itemsProperty: string, actions: Dialog[])

Paramètres

static $kind: string

Valeur de propriété

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

disabled?: BoolExpression

Valeur de propriété

Expression de chemin d’accès de propriété à l’index d’élément.

index: StringExpression

Valeur de propriété

Expression de chemin d’accès de propriété à la collection d’éléments.

itemsProperty: StringExpression

Valeur de propriété

Expression de chemin d’accès de propriété à la valeur de l’élément.

value: StringExpression

Valeur de propriété

Actions à exécuter.

actions: Dialog[]

Valeur de propriété

héritée deActionScope.actions

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

static EndOfTurn: DialogTurnResult

Valeur de propriété

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: string

Valeur de propriété

héritée de Dialog.id

telemetryClient: BotTelemetryClient

Valeur de propriété

héritée de Dialog.telemetryClient

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

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

Paramètres

Retours

Un Promise représentant l’opération asynchrone.

function getConverter(property: Object): Converter | ConverterFactory

Paramètres

Retours

Convertisseur de la configuration du sélecteur.

Obtient les dépendances boîte de dialogue enfant afin qu’elles puissent être ajoutées aux conteneurs dialogue set.

function getDependencies(): Dialog[]

Retours

Boîte de dialogue enfant dépendances.

Méthode Fluent pour la configuration de l’objet.

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

Paramètres

Retours

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

héritée de Configurable.configure

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

Retours

Un Promise représentant l’opération asynchrone.

héritée deActionScope.continueDialog

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

Retours

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

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

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

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

Retours

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

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

Retours

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

• DialogContext.repromptDialog
• invite

héritée de Dialog.repromptDialog

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

Retours

Un Promise représentant l’opération asynchrone.

héritée deActionScope.resumeDialog