Partager via

OnBeginDialog class

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

Actions déclenchées lorsqu’une boîte de dialogue est démarrée via BeginDialog().

Extends
OnDialogEvent

Constructeurs

OnBeginDialog(Dialog[], string)

Initialise une nouvelle instance de la classe OnBeginDialog.

Propriétés

$kind

Propriétés héritées

actions

Obtient ou définit les actions à ajouter au plan lorsque les contraintes de règle sont remplies.
condition

Obtient ou définit la condition qui doit être remplie pour que les actions soient exécutées (OPTIONAL).
event

Obtient ou définit l’événement à activer.
id

ID de condition.
priority

Obtient ou définit l’expression de priorité de règle où 0 est le plus élevé et inférieur à 0 est ignoré.
runOnce

Valeur indiquant si la règle ne doit s’exécuter qu’une seule fois par ensemble unique de chemins de mémoire.

Méthodes héritées

addExternalCondition(string)

Ajouter une condition externe à OnCondition
configure(Record<string, unknown>)

Méthode Fluent pour la configuration de l’objet.
currentPriority(ActionContext)

Calculez la valeur actuelle de l’expression de priorité et retournez-la.
execute(ActionContext)

Méthode appelée pour exécuter les actions de la condition.
getConverter(Object)
getDependencies()

Obtenez les dépendances de boîte de dialogue enfant afin qu’elles puissent être ajoutées à l’ensemble de dialogue conteneurs.
getExpression()

Obtenez l’expression mise en cache pour cette condition.

Détails du constructeur

OnBeginDialog(Dialog[], string)

Initialise une nouvelle instance de la classe OnBeginDialog.

new OnBeginDialog(actions?: Dialog[], condition?: string)

Paramètres

actions

Dialog[]

Optionnel. Boîte de dialogue liste contenant les actions à ajouter au plan lorsque les contraintes de règle sont remplies.

condition

string

Optionnel. Condition qui doit être remplie pour que les actions soient exécutées.

Détails de la propriété

$kind 

static $kind: string

Valeur de propriété

string

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

actions

Obtient ou définit les actions à ajouter au plan lorsque les contraintes de règle sont remplies.

actions: Dialog[]

Valeur de propriété

Dialog[]

héritée deOnCondition.actions

condition

Obtient ou définit la condition qui doit être remplie pour que les actions soient exécutées (OPTIONAL).

condition: BoolExpression

Valeur de propriété

BoolExpression

héritée deOnCondition.condition

event

Obtient ou définit l’événement à activer.

event: string

Valeur de propriété

string

héritée deOnDialogEvent.event

id

ID de condition.

id: string

Valeur de propriété

string

héritée deOnCondition.id

priority

Obtient ou définit l’expression de priorité de règle où 0 est le plus élevé et inférieur à 0 est ignoré.

priority: NumberExpression

Valeur de propriété

NumberExpression

héritée de OnCondition.priority

runOnce

Valeur indiquant si la règle ne doit s’exécuter qu’une seule fois par ensemble unique de chemins de mémoire.

runOnce: boolean

Valeur de propriété

boolean

héritée deOnCondition.runOnce

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

addExternalCondition(string)

Ajouter une condition externe à OnCondition

function addExternalCondition(condition: string)

Paramètres

condition

string

Contrainte externe à ajouter, elle sera and’ed à toutes les autres contraintes.

héritée deOnCondition.addExternalCondition

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

currentPriority(ActionContext)

Calculez la valeur actuelle de l’expression de priorité et retournez-la.

function currentPriority(actionContext: ActionContext): number

Paramètres

actionContext
ActionContext

Contexte à utiliser pour l’évaluation.

Retours

number

Priorité calculée.

héritée deOnCondition.currentPriority

execute(ActionContext)

Méthode appelée pour exécuter les actions de la condition.

function execute(actionContext: ActionContext): Promise<ActionChangeList[]>

Paramètres

actionContext
ActionContext

Contexte.

Retours

Promise<ActionChangeList[]>

Promesse avec la liste des modifications de plan.

héritée deOnCondition.execute

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 deOnCondition.getConverter

getDependencies()

Obtenez les dépendances de boîte de dialogue enfant afin qu’elles puissent être ajoutées à l’ensemble de dialogue conteneurs.

function getDependencies(): Dialog[]

Retours

Dialog[]

Liste des boîte de dialogue.

héritée deOnCondition.getDependencies

getExpression()

Obtenez l’expression mise en cache pour cette condition.

function getExpression(): Expression

Retours

Expression

Expression mise en cache utilisée pour évaluer cette condition.

héritée deOnCondition.getExpression