Prompt<T> Klasse

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

Typparameter

T

Geben Sie die Eingabeaufforderung ein, für die sie erstellt wird.

public abstract class Prompt
extends Dialog

Definiert das Kernverhalten von Eingabeaufforderungsdialogfeldern. Wenn die Eingabeaufforderung endet, sollte ein Objekt zurückgegeben werden, das den Wert darstellt, der dazu aufgefordert wurde. Verwenden Sie add(Dialog dialog) oder addDialog(Dialog dialog), um einem Dialogfeld oder Komponentendialogfeld eine Eingabeaufforderung hinzuzufügen. Verwenden Sie prompt(String dialogId, PromptOptions options) oder beginDialog(String dialogId, Object options), um die Eingabeaufforderung zu starten. Wenn Sie eine Eingabeaufforderung von einem WaterfallStep in einem WaterfallDialogstarten, steht das Eingabeaufforderungsergebnis im nächsten Schritt des Wasserfalls zur Verfügung.

Feldzusammenfassung

Modifizierer und Typ Feld und Beschreibung
static final java.lang.String ATTEMPTCOUNTKEY

Zusammenfassung zum Konstruktor

Konstruktor Beschreibung
Prompt(String dialogId, PromptValidator<T> validator)

Initialisiert eine neue Instanz der {@link Prompt{T}}-Klasse.

Methodenzusammenfassung

Modifizierer und Typ Methode und Beschreibung
protected Activity appendChoices(Activity prompt, String channelId, List<Choice> choices, ListStyle style, ChoiceFactoryOptions options)

Wenn eine abgeleitete Klasse überschrieben wird, werden auswahlmöglichkeiten an die Aktivität angefügt, wenn der Benutzer zur Eingabe aufgefordert wird.
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.Boolean> onPreBubbleEvent(DialogContext dc, DialogEvent e)

Wird aufgerufen, bevor ein Ereignis in das übergeordnete Element eingeblasen wird.
protected abstract 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 abstract java.util.concurrent.CompletableFuture<PromptRecognizerResult<T>> onRecognize(TurnContext turnContext, Map<String,Object> state, PromptOptions options)

Wenn sie in einer abgeleiteten Klasse überschrieben wird, wird versucht, die Eingabe des Benutzers 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

Felddetails

ATTEMPTCOUNTKEY

public static final String ATTEMPTCOUNTKEY

Details zum Konstruktor

Prompt

public Prompt(String dialogId, PromptValidator validator)

Initialisiert eine neue Instanz der {@link Prompt{T}}-Klasse. Wird von Konstruktoren in abgeleiteten Klassen aufgerufen, um die {@link Prompt{T}}-Klasse zu initialisieren.

Parameter:

dialogId - Die ID, die dieser Eingabeaufforderung zugewiesen werden soll.
validator - Optional, ein {@link PromptValidator{T}} mit zusätzlicher, benutzerdefinierter Überprüfung für diese Eingabeaufforderung. 
              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="com.microsoft.bot.dialogs.DialogSet"></xref> or
              <xref uid="com.microsoft.bot.dialogs.ComponentDialog" data-throw-if-not-resolved="false" data-raw-source="com.microsoft.bot.dialogs.ComponentDialog"></xref> to which
              the prompt is added.

Details zur Methode

appendChoices

protected Activity appendChoices(Activity prompt, String channelId, List choices, ListStyle style, ChoiceFactoryOptions options)

Wenn eine abgeleitete Klasse überschrieben wird, werden auswahlmöglichkeiten an die Aktivität angefügt, wenn der Benutzer zur Eingabe aufgefordert wird.

Parameter:

prompt - Die Aktivität, an die die Auswahl angefügt werden soll.
channelId - Die ID des Kanals des Benutzers.
choices - Die anzufügenden Optionen.
style - Gibt an, wie die Auswahl dem Benutzer angezeigt werden soll.
options - Die Formatierungsoptionen, die beim Darstellen der Auswahl verwendet werden sollen.

Gibt zurück:

Eine CompletableFuture, die den asynchronen Vorgang darstellt. 
     If the task is successful, the result contains the updated activity.

beginDialog

public CompletableFuture beginDialog(DialogContext dc, Object options)

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

Überschreibt:

Prompt<T>.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:

Prompt<T>.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.

onPreBubbleEvent

protected CompletableFuture onPreBubbleEvent(DialogContext dc, DialogEvent e)

Wird aufgerufen, bevor ein Ereignis in das übergeordnete Element eingeblasen wird. Dies ist ein guter Ort, um das Abfangen eines Ereignisses durchzuführen, da das Zurückgeben von "true" eine weitere Bubbling des Ereignisses an die übergeordneten Dialoge verhindert und auch verhindert, dass untergeordnete Dialogfelder ihre Standardverarbeitung ausführen.

Überschreibt:

Prompt<T>.onPreBubbleEvent(DialogContext dc, DialogEvent e)

Parameter:

dc - Der Dialogkontext für die aktuelle Unterhaltungswende.
e - Das ausgelöste Ereignis.

Gibt zurück:

Gibt an, ob das Ereignis vom aktuellen Dialogfeld behandelt wird und die weitere Verarbeitung beendet werden soll.

onPrompt

protected abstract 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 - "true", wenn dies das erste Mal ist, wenn sich diese Eingabeaufforderungsdialoginstanz im Stapel befindet, den Benutzer zur Eingabe auffordert. andernfalls "false". Bestimmt, ob getPrompt() oder getRetryPrompt() verwendet werden sollen.

Gibt zurück:

Eine CompletableFuture, die den asynchronen Vorgang darstellt.

onRecognize

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

Wenn sie in einer abgeleiteten Klasse überschrieben wird, wird versucht, die Eingabe des Benutzers 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:

Prompt<T>.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:

Prompt<T>.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: