SkillDialog Klasse

  • Referenz
Paket:
com.microsoft.bot.dialogs
Maven-Artefakt:
com.microsoft.bot:bot-dialogs:4.14.3

public class SkillDialog
extends Dialog

Eine spezielle Dialog, die Remoteanrufe an eine Fähigkeit umschließen kann. Der Optionsparameter in BeginDialog muss eine BeginSkillDialogOptions Instanz mit den anfänglichen Parametern für das Dialogfeld sein.

Zusammenfassung zum Konstruktor

Konstruktor Beschreibung
SkillDialog(SkillDialogOptions dialogOptions, String dialogId)

Initialisiert eine neue Instanz der SkillDialog Klasse, um Remoteanrufe an eine Fähigkeit umzuschließen.

Methodenzusammenfassung

Modifizierer und Typ Methode und Beschreibung
java.util.concurrent.CompletableFuture<DialogTurnResult> beginDialog(DialogContext dc, Object options)

Wird aufgerufen, wenn das Fähigkeitsdialogfeld gestartet und auf den Dialogstapel verschoben wird.
java.util.concurrent.CompletableFuture<DialogTurnResult> continueDialog(DialogContext dc)

Wird aufgerufen, wenn das Qualifikationsdialogfeld _fortsetzung_ ist, wobei es sich um das aktive Dialogfeld handelt und der Benutzer mit einer neuen Aktivität antwortet.
java.util.concurrent.CompletableFuture<java.lang.Void> endDialog(TurnContext turnContext, DialogInstance instance, DialogReason reason)

Wird aufgerufen, wenn das Qualifikationsdialogfeld beendet wird.
protected SkillDialogOptions getDialogOptions()

Ruft die Optionen ab, die zum Ausführen des Fähigkeitsdialogfelds verwendet werden.
protected boolean onValidateActivity(Activity activity)

Überprüft die Aktivität, die während des Dialogfelds "Weiter" gesendet wurde.
java.util.concurrent.CompletableFuture<java.lang.Void> repromptDialog(TurnContext turnContext, DialogInstance instance)

Wird aufgerufen, wenn das Qualifikationsdialogfeld den Benutzer erneut zur Eingabe auffordert.
java.util.concurrent.CompletableFuture<DialogTurnResult> resumeDialog(DialogContext dc, DialogReason reason, Object result)

Wird aufgerufen, wenn ein Dialogfeld mit untergeordneten Fähigkeiten seine Drehung abgeschlossen hat, und gibt das Steuerelement zu diesem Dialogfeld zurück.

Geerbte Methoden von Dialog

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

Geerbte Methoden von 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

Details zum Konstruktor

SkillDialog

public SkillDialog(SkillDialogOptions dialogOptions, String dialogId)

Initialisiert eine neue Instanz der SkillDialog Klasse, um Remoteanrufe an eine Fähigkeit umzuschließen.

Parameter:

dialogOptions - Die Optionen zum Ausführen des Fähigkeitsdialogfelds.
dialogId - Die ID des Dialogfelds.

Details zur Methode

beginDialog

public CompletableFuture beginDialog(DialogContext dc, Object options)

Wird aufgerufen, wenn das Fähigkeitsdialogfeld gestartet und auf den Dialogstapel verschoben wird.

Überschreibt:

SkillDialog.beginDialog(DialogContext dc, Object options)

Parameter:

dc - Die DialogContext für die aktuelle Unterhaltungswende.
options - Optional, erste Informationen, die an das Dialogfeld übergeben werden sollen.

Gibt zurück:

Eine CompletableFuture, die den asynchronen Vorgang darstellt. 
     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)

Wird aufgerufen, wenn das Qualifikationsdialogfeld _fortsetzung_ ist, wobei es sich um das aktive Dialogfeld handelt und der Benutzer mit einer neuen Aktivität antwortet.

Überschreibt:

SkillDialog.continueDialog(DialogContext dc)

Parameter:

dc - Die DialogContext für die aktuelle Unterhaltungswende.

Gibt zurück:

Eine CompletableFuture, die den asynchronen Vorgang darstellt. 
     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)

Wird aufgerufen, wenn das Qualifikationsdialogfeld beendet wird.

Überschreibt:

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

Parameter:

turnContext - Das Kontextobjekt für diese Drehung.
instance - Statusinformationen, die der Instanz dieses Dialogfelds im Dialogstapel zugeordnet sind.
reason - Grund, warum das Dialogfeld beendet wurde.

Gibt zurück:

Eine CompletableFuture, die den asynchronen Vorgang darstellt.

getDialogOptions

protected SkillDialogOptions getDialogOptions()

Ruft die Optionen ab, die zum Ausführen des Fähigkeitsdialogfelds verwendet werden.

Gibt zurück:

der DialogOptions-Wert als SkillDialogOptions-Wert.

onValidateActivity

protected boolean onValidateActivity(Activity activity)

Überprüft die Während von ContinueDialog gesendete Aktivität.

Parameter:

activity - Die Activity für die aktuelle Unterhaltungswende. 
             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.

Gibt zurück:

"true", wenn die Aktivität gültig ist, wenn dies nicht der Fall ist.

repromptDialog

public CompletableFuture repromptDialog(TurnContext turnContext, DialogInstance instance)

Wird aufgerufen, wenn das Qualifikationsdialogfeld den Benutzer erneut zur Eingabe auffordert.

Überschreibt:

SkillDialog.repromptDialog(TurnContext turnContext, DialogInstance instance)

Parameter:

turnContext - Das Kontextobjekt für diese Drehung.
instance - Statusinformationen für dieses Dialogfeld.

Gibt zurück:

Eine CompletableFuture, die den asynchronen Vorgang darstellt.

resumeDialog

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

Wird aufgerufen, wenn ein Dialogfeld mit untergeordneten Fähigkeiten seine Drehung abgeschlossen hat, und gibt das Steuerelement zu diesem Dialogfeld zurück.

Überschreibt:

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

Parameter:

dc - Der Dialogfeldkontext für die aktuelle Drehung der Unterhaltung.
reason - Grund, warum das Dialogfeld fortgesetzt wurde.
result - Optionaler Wert, der aus dem aufgerufenen Dialogfeld zurückgegeben wurde. Der Typ des zurückgegebenen Werts hängt vom untergeordneten Dialogfeld ab.

Gibt zurück:

Eine CompletableFuture, die den asynchronen Vorgang darstellt.

Gilt für: