Partager via

ForEachPage class

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

Exécute un ensemble d’actions une fois pour chaque page de résultats dans une liste ou une collection en mémoire.

Extends

ActionScope<O>

Remarques

La liste ou la collection à propriété sera divisée en pages et stockée dans dialog.page pour chaque itération de la boucle. La taille de chaque page est déterminée par maxSize et la valeur par défaut est de 10. La boucle peut être quittée tôt en incluant une action EndDialog ou GotoDialog.

Constructeurs

ForEachPage()

Propriétés

$kind
disabled

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

Expression utilisée pour calculer la liste qui doit être énumérée.
page

Expression utilisée pour calculer la liste qui doit être énumérée.
pageIndex

Expression utilisée pour calculer la liste qui doit être énumérée.
pageSize

Taille de page, valeur par défaut 10.

Propriétés héritées

actions

Actions à exécuter.
EndOfTurn

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

Méthodes

beginDialog(DialogContext, O)

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

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

Méthodes héritées

configure(Record<string, unknown>)

Méthode Fluent pour la configuration de l’objet.
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é.
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.
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.
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é.
repromptDialog(TurnContext, DialogInstance)

En cas de substitution dans une classe dérivée, repromène l’utilisateur pour l’entrée.
resumeDialog(DialogContext, DialogReason, any)

Appelé lorsqu’un dialogue enfant terminé son tour, renvoyant le contrôle à ce dialogue.

Détails du constructeur

ForEachPage() 

new ForEachPage()

Détails de la propriété

$kind 

static $kind: string

Valeur de propriété

string

disabled

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

disabled?: BoolExpression

Valeur de propriété

BoolExpression

itemsProperty

Expression utilisée pour calculer la liste qui doit être énumérée.

itemsProperty: StringExpression

Valeur de propriété

StringExpression

page

Expression utilisée pour calculer la liste qui doit être énumérée.

page: StringExpression

Valeur de propriété

StringExpression

pageIndex

Expression utilisée pour calculer la liste qui doit être énumérée.

pageIndex: StringExpression

Valeur de propriété

StringExpression

pageSize

Taille de page, valeur par défaut 10.

pageSize: IntExpression

Valeur de propriété

IntExpression

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

actions

Actions à exécuter.

actions: Dialog[]

Valeur de propriété

Dialog[]

héritée deActionScope.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

beginDialog(DialogContext, O)

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

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.

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.

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.

Détails de la méthode héritée

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

héritée de Dialog.endDialog

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