ActivityPrompt Klasse

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

public class ActivityPrompt
extends Dialog

Definiert das Kernverhalten eines Eingabeaufforderungsdialogfelds, das auf den Empfang einer Aktivität wartet. Diese Eingabeaufforderung erfordert, dass ein Validator übergeben wird und nützlich ist, wenn auf Nichtnachrichtenaktivitäten wie ein Ereignis gewartet wird, das empfangen wird. Der Validator kann empfangene Aktivitäten ignorieren, bis der erwartete Aktivitätstyp empfangen wird.

Zusammenfassung zum Konstruktor

Konstruktor Beschreibung
ActivityPrompt(String dialogId, PromptValidator<Activity> validator)

Initialisiert eine neue Instanz der ActivityPrompt Klasse.

Methodenzusammenfassung

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

Wird aufgerufen, wenn ein Eingabeaufforderungsdialogfeld auf den Dialogstapel verschoben wird und aktiviert wird.
java.util.concurrent.CompletableFuture<DialogTurnResult> continueDialog(DialogContext dc)

Wird aufgerufen, wenn ein Eingabeaufforderungsdialogfeld das aktive Dialogfeld ist und der Benutzer mit einer neuen Aktivität geantwortet hat.
protected java.util.concurrent.CompletableFuture<java.lang.Void> onPrompt(TurnContext turnContext, Map<String,Object> state, PromptOptions options)

Wenn sie in einer abgeleiteten Klasse überschrieben wird, fordert der Benutzer zur Eingabe auf.
protected java.util.concurrent.CompletableFuture<java.lang.Void> onPrompt(TurnContext turnContext, Map<String,Object> state, PromptOptions options, Boolean isRetry)

Wenn sie in einer abgeleiteten Klasse überschrieben wird, fordert der Benutzer zur Eingabe auf.
protected java.util.concurrent.CompletableFuture<PromptRecognizerResult<Activity>> onRecognize(TurnContext turnContext, Map<String,Object> state, PromptOptions options)

Wenn sie in einer abgeleiteten Klasse überschrieben wird, wird versucht, die eingehende Aktivität zu erkennen.
java.util.concurrent.CompletableFuture<java.lang.Void> repromptDialog(TurnContext turnContext, DialogInstance instance)

Wird aufgerufen, wenn ein Eingabeaufforderungsdialogfeld aufgefordert wurde, den Benutzer erneut zur Eingabe aufzufordern.
java.util.concurrent.CompletableFuture<DialogTurnResult> resumeDialog(DialogContext dc, DialogReason reason, Object result)

Wird aufgerufen, wenn ein Eingabeaufforderungsdialogfeld wieder das aktive Dialogfeld im Dialogstapel ist, z. B. wenn das vorherige aktive Dialogfeld im Stapel abgeschlossen ist.

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

ActivityPrompt

public ActivityPrompt(String dialogId, PromptValidator validator)

Initialisiert eine neue Instanz der ActivityPrompt Klasse. Wird von Konstruktoren in abgeleiteten Klassen aufgerufen, um die ActivityPrompt Klasse zu initialisieren.

Parameter:

dialogId - Die ID, die dieser Eingabeaufforderung zugewiesen werden soll.
validator - Eine PromptValidator<T>, die die Überprüfung für diese Eingabeaufforderung enthält. 
              The value of dialogId must be unique within the
              <xref uid="com.microsoft.bot.dialogs.DialogSet" data-throw-if-not-resolved="false" data-raw-source="DialogSet"></xref> or <xref uid="com.microsoft.bot.dialogs.ComponentDialog" data-throw-if-not-resolved="false" data-raw-source="ComponentDialog"></xref> to which the
              prompt is added.

Details zur Methode

beginDialog

public CompletableFuture beginDialog(DialogContext dc, Object options)

Wird aufgerufen, wenn ein Eingabeaufforderungsdialogfeld auf den Dialogstapel verschoben wird und aktiviert wird.

Überschreibt:

ActivityPrompt.beginDialog(DialogContext dc, Object options)

Parameter:

dc - Der Dialogfeldkontext für die aktuelle Drehung der Unterhaltung.
options - Optional, zusätzliche Informationen, die an die eingabeaufforderung übergeben werden sollen, die gestartet wird.

Gibt zurück:

Eine CompletableFuture, die den asynchronen Vorgang darstellt. 
     If the task is successful, the result indicates whether the prompt is
     still active after the turn has been processed by the prompt.

continueDialog

public CompletableFuture continueDialog(DialogContext dc)

Wird aufgerufen, wenn ein Eingabeaufforderungsdialogfeld das aktive Dialogfeld ist und der Benutzer mit einer neuen Aktivität geantwortet hat.

Überschreibt:

ActivityPrompt.continueDialog(DialogContext dc)

Parameter:

dc - Der Dialogkontext 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
     prompt generally continues to receive the user's replies until it
     accepts the user's reply as valid input for the prompt.

onPrompt

protected CompletableFuture onPrompt(TurnContext turnContext, Map state, PromptOptions options)

Wenn sie in einer abgeleiteten Klasse überschrieben wird, fordert der Benutzer zur Eingabe auf.

Parameter:

turnContext - Kontext für die aktuelle Unterhaltungswende mit dem Benutzer.
state - Enthält den Status für die aktuelle Instanz der Eingabeaufforderung im Dialogstapel.
options - Ein Eingabeaufforderungsoptionenobjekt, das aus den optionen erstellt wurde, die anfänglich im Aufruf von prompt(String dialogId, PromptOptions options) bereitgestellt wurden.

Gibt zurück:

Eine CompletableFuture, die den asynchronen Vorgang darstellt.

onPrompt

protected CompletableFuture onPrompt(TurnContext turnContext, Map state, PromptOptions options, Boolean isRetry)

Wenn sie in einer abgeleiteten Klasse überschrieben wird, fordert der Benutzer zur Eingabe auf.

Parameter:

turnContext - Kontext für die aktuelle Unterhaltungswende mit dem Benutzer.
state - Enthält den Status für die aktuelle Instanz der Eingabeaufforderung im Dialogstapel.
options - Ein Eingabeaufforderungsoptionenobjekt, das aus den optionen erstellt wurde, die anfänglich im Aufruf von prompt(String dialogId, PromptOptions options) bereitgestellt wurden.
isRetry - Ein Boolean, der angibt, ob die Eingabeaufforderung ein Wiederholungsversuche ist.

Gibt zurück:

Eine CompletableFuture, die das Ergebnis des asynchronen Vorgangs darstellt.

onRecognize

protected CompletableFuture> onRecognize(TurnContext turnContext, Map state, PromptOptions options)

Wenn sie in einer abgeleiteten Klasse überschrieben wird, wird versucht, die eingehende Aktivität zu erkennen.

Parameter:

turnContext - Kontext für die aktuelle Unterhaltungswende mit dem Benutzer.
state - Enthält den Status für die aktuelle Instanz der Eingabeaufforderung im Dialogstapel.
options - Ein Eingabeaufforderungsoptionenobjekt, das aus den optionen erstellt wurde, die anfänglich im Aufruf von prompt(String dialogId, PromptOptions options) bereitgestellt wurden.

Gibt zurück:

Eine CompletableFuture, die den asynchronen Vorgang darstellt. 
     If the task is successful, the result describes the result of the
     recognition attempt.

repromptDialog

public CompletableFuture repromptDialog(TurnContext turnContext, DialogInstance instance)

Wird aufgerufen, wenn ein Eingabeaufforderungsdialogfeld aufgefordert wurde, den Benutzer erneut zur Eingabe aufzufordern.

Überschreibt:

ActivityPrompt.repromptDialog(TurnContext turnContext, DialogInstance instance)

Parameter:

turnContext - Kontext für die aktuelle Unterhaltungswende mit dem Benutzer.
instance - Die Instanz des Dialogfelds im Stapel.

Gibt zurück:

Eine CompletableFuture, die den asynchronen Vorgang darstellt.

resumeDialog

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

Wird aufgerufen, wenn ein Eingabeaufforderungsdialogfeld wieder das aktive Dialogfeld im Dialogstapel ist, z. B. wenn das vorherige aktive Dialogfeld im Stapel abgeschlossen ist.

Überschreibt:

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

Parameter:

dc - Der Dialogfeldkontext für die aktuelle Drehung der Unterhaltung.
reason - Eine Enumeration, die angibt, warum das Dialogfeld fortgesetzt wurde.
result - Optionaler Wert, der aus dem vorherigen Dialogfeld im Stapel zurückgegeben wird. Der Typ des zurückgegebenen Werts hängt vom vorherigen Dialogfeld ab.

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.

Gilt für: