AttachmentPrompt Klasse

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

public class AttachmentPrompt
extends Prompt<java.util.List<Attachment>>

Fordert einen Benutzer auf, Anlagen wie Bilder hochzuladen.

Zusammenfassung zum Konstruktor

Konstruktor Beschreibung
AttachmentPrompt(String dialogId)

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

Initialisiert eine neue Instanz der AttachmentPrompt Klasse.

Methodenzusammenfassung

Modifizierer und Typ Methode und Beschreibung
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.util.List<Attachment>>> 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

AttachmentPrompt

public AttachmentPrompt(String dialogId)

Initialisiert eine neue Instanz der AttachmentPrompt Klasse.

Parameter:

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

AttachmentPrompt

public AttachmentPrompt(String dialogId, PromptValidator> validator)

Initialisiert eine neue Instanz der AttachmentPrompt Klasse.

Parameter:

dialogId - Die ID, die dieser Eingabeaufforderung zugewiesen werden soll.
validator - Optional, eine PromptValidator<T>, die zusätzliche, benutzerdefinierte Überprüfung für diese Eingabeaufforderung enthält. Der Wert von dialogId muss innerhalb des DialogSet oder ComponentDialog eindeutig sein, zu dem die Eingabeaufforderung hinzugefügt wird.

Details zur Methode

onPrompt

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

Fordert den Benutzer zur Eingabe auf.

Überschreibt:

AttachmentPrompt.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 DialogContext(String, PromptOptions) 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:

AttachmentPrompt.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 DialogContext(String, PromptOptions) 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: