SkillDialog Classe

  • Référence
Paquet:
com.microsoft.bot.dialogs
Artefact Maven:
com.microsoft.bot:bot-dialogs:4.14.3

public class SkillDialog
extends Dialog

Un Dialog spécialisé qui peut encapsuler les appels distants à une compétence. Le paramètre d’options dans BeginDialog doit être une instance BeginSkillDialogOptions avec les paramètres initiaux de la boîte de dialogue.

Récapitulatif du constructeur

Constructeur Description
SkillDialog(SkillDialogOptions dialogOptions, String dialogId)

Initialise une nouvelle instance de la classe SkillDialog pour encapsuler les appels distants à une compétence.

Résumé de la méthode

Modificateur et type Méthode et description
java.util.concurrent.CompletableFuture<DialogTurnResult> beginDialog(DialogContext dc, Object options)

Appelé lorsque le dialogue de compétence est démarré et envoyé (push) sur la pile de dialogues.
java.util.concurrent.CompletableFuture<DialogTurnResult> continueDialog(DialogContext dc)

Appelé lorsque le dialogue de compétence est _continue_, où il s’agit du dialogue actif et que l’utilisateur répond avec une nouvelle activité.
java.util.concurrent.CompletableFuture<java.lang.Void> endDialog(TurnContext turnContext, DialogInstance instance, DialogReason reason)

Appelé lorsque la boîte de dialogue de compétence se termine.
protected SkillDialogOptions getDialogOptions()

Obtient les options utilisées pour exécuter la boîte de dialogue de compétence.
protected boolean onValidateActivity(Activity activity)

Valide l’activité envoyée pendant la boîte de dialogue Continuer.
java.util.concurrent.CompletableFuture<java.lang.Void> repromptDialog(TurnContext turnContext, DialogInstance instance)

Appelé lorsque la boîte de dialogue de compétence doit inviter l’utilisateur à entrer à nouveau.
java.util.concurrent.CompletableFuture<DialogTurnResult> resumeDialog(DialogContext dc, DialogReason reason, Object result)

Appelé lorsqu’un dialogue de compétence enfant a terminé son tour, retournant le contrôle à ce dialogue.

Méthodes héritées de Dialog

beginDialog beginDialog continueDialog endDialog getId getTelemetryClient getVersion innerRun onComputeId onDialogEvent onPostBubbleEvent onPreBubbleEvent repromptDialog resumeDialog resumeDialog run setId setTelemetryClient

Méthodes héritées de java.lang.Object

java.lang.Object.clone java.lang.Object.equals java.lang.Object.finalize java.lang.Object.getClass java.lang.Object.hashCode java.lang.Object.notify java.lang.Object.notifyAll java.lang.Object.toString java.lang.Object.wait java.lang.Object.wait java.lang.Object.wait

Détails du constructeur

SkillDialog

public SkillDialog(SkillDialogOptions dialogOptions, String dialogId)

Initialise une nouvelle instance de la classe SkillDialog pour encapsuler les appels distants à une compétence.

Paramètres:

dialogOptions - Options d’exécution de la boîte de dialogue de compétence.
dialogId - ID de la boîte de dialogue.

Détails de la méthode

beginDialog

public CompletableFuture beginDialog(DialogContext dc, Object options)

Appelé lorsque le dialogue de compétence est démarré et envoyé (push) sur la pile de dialogues.

Remplacements:

SkillDialog.beginDialog(DialogContext dc, Object options)

Paramètres:

dc - DialogContext pour le tour actuel de la conversation.
options - Informations initiales facultatives à transmettre à la boîte de dialogue.

Retours:

Un CompletableFuture représentant l’opération asynchrone. 
     If the task is successful, the result indicates whether the dialog is
     still active after the turn has been processed by the dialog.

continueDialog

public CompletableFuture continueDialog(DialogContext dc)

Appelé lorsque le dialogue de compétence est _continue_, où il s’agit du dialogue actif et que l’utilisateur répond avec une nouvelle activité.

Remplacements:

SkillDialog.continueDialog(DialogContext dc)

Paramètres:

dc - DialogContext pour le tour actuel de la conversation.

Retours:

Un CompletableFuture représentant l’opération asynchrone. 
     If the task is successful, the result indicates whether the dialog is
     still active after the turn has been processed by the dialog. The
     result may also contain a return value.

endDialog

public CompletableFuture endDialog(TurnContext turnContext, DialogInstance instance, DialogReason reason)

Appelé lorsque la boîte de dialogue de compétence se termine.

Remplacements:

SkillDialog.endDialog(TurnContext turnContext, DialogInstance instance, DialogReason reason)

Paramètres:

turnContext - Objet de contexte pour ce tour.
instance - Informations d’état associées à l’instance de cette boîte de dialogue sur la pile de dialogues.
reason - Raison pour laquelle le dialogue s’est terminé.

Retours:

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

getDialogOptions

protected SkillDialogOptions getDialogOptions()

Obtient les options utilisées pour exécuter la boîte de dialogue de compétence.

Retours:

valeur DialogOptions en tant que SkillDialogOptions.

onValidateActivity

protected boolean onValidateActivity(Activity activity)

Valide l’activité envoyée pendant ContinueDialog .

Paramètres:

activity - Activity pour le tour actuel de la conversation. 
             Override this method to implement a custom validator for the
             activity being sent during the ContinueDialog . This
             method can be used to ignore activities of a certain type if
             needed. If this method returns false, the dialog will end the
             turn without processing the activity.

Retours:

true si l’activité est valide, false si ce n’est pas le cas.

repromptDialog

public CompletableFuture repromptDialog(TurnContext turnContext, DialogInstance instance)

Appelé lorsque la boîte de dialogue de compétence doit inviter l’utilisateur à entrer à nouveau.

Remplacements:

SkillDialog.repromptDialog(TurnContext turnContext, DialogInstance instance)

Paramètres:

turnContext - Objet de contexte pour ce tour.
instance - Informations d’état pour cette boîte de dialogue.

Retours:

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

resumeDialog

public CompletableFuture resumeDialog(DialogContext dc, DialogReason reason, Object result)

Appelé lorsqu’un dialogue de compétence enfant a terminé son tour, retournant le contrôle à ce dialogue.

Remplacements:

SkillDialog.resumeDialog(DialogContext dc, DialogReason reason, Object result)

Paramètres:

dc - Contexte de boîte de dialogue pour le tour actuel de la conversation.
reason - Raison pour laquelle le dialogue a repris.
result - Facultatif, valeur retournée à partir de la boîte de dialogue appelée. Le type de la valeur retournée dépend de la boîte de dialogue enfant.

Retours:

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

S’applique à