TextPrompt Klasse

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

public class TextPrompt
extends Prompt<java.lang.String>

Fordert den Benutzer zur Texteingabe auf.

Zusammenfassung zum Konstruktor

Konstruktor Beschreibung
TextPrompt(String dialogId)

Initialisiert eine neue Instanz der TextPrompt Klasse.
TextPrompt(String dialogId, PromptValidator<String> validator)

Initialisiert eine neue Instanz der TextPrompt Klasse.

Methodenzusammenfassung

Modifizierer und Typ Methode und Beschreibung
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 java.util.concurrent.CompletableFuture<java.lang.Void> onPrompt(TurnContext turnContext, Map<String,Object> state, PromptOptions options, Boolean isRetry)

Fordert den Benutzer zur Eingabe auf.
protected java.util.concurrent.CompletableFuture<PromptRecognizerResult<java.lang.String>> onRecognize(TurnContext turnContext, Map<String,Object> state, PromptOptions options)

Versucht, die Eingabe des Benutzers zu erkennen.

Geerbte Methoden von Dialog

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

Geerbte Methoden von Prompt

appendChoices beginDialog continueDialog onPreBubbleEvent onPrompt onRecognize repromptDialog resumeDialog

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

TextPrompt

public TextPrompt(String dialogId)

Initialisiert eine neue Instanz der TextPrompt Klasse.

Parameter:

dialogId - Die ID, die dieser Eingabeaufforderung zugewiesen werden soll. Der Wert von dialogId muss innerhalb des DialogSet oder ComponentDialog eindeutig sein, dem die Eingabeaufforderung hinzugefügt wird.

TextPrompt

public TextPrompt(String dialogId, PromptValidator validator)

Initialisiert eine neue Instanz der TextPrompt Klasse.

Parameter:

dialogId - Die ID, die dieser Eingabeaufforderung zugewiesen werden soll.
validator - Optional, ein {@link PromptValidator{FoundChoice}} mit zusätzlicher, benutzerdefinierter Überprüfung für diese Eingabeaufforderung. Der Wert von dialogId muss innerhalb des DialogSet oder ComponentDialog eindeutig sein, dem die Eingabeaufforderung hinzugefügt wird.

Details zur Methode

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:

TextPrompt.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 CompletableFuture onPrompt(TurnContext turnContext, Map state, PromptOptions options, Boolean isRetry)

Fordert den Benutzer zur Eingabe auf.

Überschreibt:

TextPrompt.onPrompt(TurnContext turnContext, Map<String,Object> state, PromptOptions options, Boolean isRetry)

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 diese Eingabeaufforderungsdialoginstanz im Stapel den Benutzer zur Eingabe auffordert. andernfalls "false".

Gibt zurück:

Eine CompletableFuture, die den asynchronen Vorgang darstellt.

onRecognize

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

Versucht, die Eingabe des Benutzers zu erkennen.

Überschreibt:

TextPrompt.onRecognize(TurnContext turnContext, Map<String,Object> state, PromptOptions options)

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. Wenn der Vorgang erfolgreich ist, beschreibt das Ergebnis das Ergebnis des Erkennungsversuchs.

Gilt für: