Partager via

DialogAction class

  • Référence
Paquet:
botbuilder

Les actions de boîte de dialogue offrent des raccourcis statiques pour implémenter des actions courantes. Ils implémentent également la prise en charge des actions nommées qui peuvent être liées à une boîte de dialogue pour gérer les énoncés globaux de l’utilisateur comme « aide » ou « annuler ». Les actions sont envoyées sur et hors de la pile de dialogues dans le cadre de dialogues afin que ces écouteurs puissent entrer et sortir de l’étendue à mesure que la conversation progresse. Vous pouvez également lier des actions nommées à des boutons qui permettent à votre bot de répondre aux clics de bouton sur les cartes qui ont peut-être fait défiler l’écran.

Méthodes

beginDialog<T>(string, T)

Retourne une fermeture qui passe le contrôle de la conversation à une nouvelle boîte de dialogue.
endDialog(any)

Retourne une fermeture qui met fin à la boîte de dialogue active.
send(string, any[])

Retourne une fermeture qui enverra un message texte simple à l’utilisateur.
validatedPrompt(PromptType, (response: any) => boolean)

Retourne une fermeture qui encapsule une invite intégrée avec une logique de validation. La fermeture doit être utilisée pour définir une nouvelle boîte de dialogue pour l’invite à l’aide de bot.add('/myPrompt', générateur. DialogAction.)

Détails de la méthode

beginDialog<T>(string, T)

Retourne une fermeture qui passe le contrôle de la conversation à une nouvelle boîte de dialogue.

static function beginDialog<T>(id: string, args?: T)

Paramètres

id

string

ID unique de la boîte de dialogue à démarrer.

args

T

(Facultatif) arguments à passer à la méthode begin() des dialogues.

Retours

IDialogWaterfallStep

endDialog(any)

Retourne une fermeture qui met fin à la boîte de dialogue active.

static function endDialog(result?: any)

Paramètres

result

any

(Facultatif) résultats à passer à la boîte de dialogue parent.

Retours

IDialogWaterfallStep

send(string, any[])

Retourne une fermeture qui enverra un message texte simple à l’utilisateur.

static function send(msg: string, args: any[])

Paramètres

msg

string

Texte du message à envoyer. Le message sera localisé à l’aide des sessions configurées localiseur. Si les arguments sont passés dans le message seront mis en forme à l’aide de sprintf-js (consultez la documentation pour plus d’informations.)

args

any[]

(Facultatif) arguments utilisés pour mettre en forme la chaîne de sortie finale.

Retours

IDialogWaterfallStep

validatedPrompt(PromptType, (response: any) => boolean)

Retourne une fermeture qui encapsule une invite intégrée avec une logique de validation. La fermeture doit être utilisée pour définir une nouvelle boîte de dialogue pour l’invite à l’aide de bot.add('/myPrompt', générateur. DialogAction.)

static function validatedPrompt(promptType: PromptType, validator: (response: any) => boolean)

Paramètres

promptType
PromptType

Type d’invite intégrée à valider.

validator

(response: any) => boolean

Fonction utilisée pour valider la réponse. Doit retourner true si la réponse est valide.

Retours

Dialog