ChoicePrompt Klasse

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

public class ChoicePrompt
extends Prompt<FoundChoice>

Fordert einen Benutzer auf, aus einer Liste mit Auswahlmöglichkeiten auszuwählen.

Zusammenfassung zum Konstruktor

Konstruktor Beschreibung
ChoicePrompt(String dialogId)

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

Initialisiert eine neue Instanz der ChoicePrompt Klasse.
ChoicePrompt(String dialogId, Map<String,ChoiceFactoryOptions> choiceDefaults, PromptValidator<FoundChoice> validator, String defaultLocale)

Initialisiert eine neue Instanz der ChoicePrompt Klasse.

Methodenzusammenfassung

Modifizierer und Typ Methode und Beschreibung
ChoiceFactoryOptions getChoiceOptions()

Ruft zusätzliche Optionen ab, die an die ChoiceFactory übergeben und verwendet werden, um die Art der Auswahl zu optimieren, die für den Benutzer gerendert wird.
java.lang.String getDefaultLocale()

Legt das Standardgebietsschema fest, das zum Bestimmen des sprachspezifischen Verhaltens der Eingabeaufforderung verwendet wird, oder legt dieses fest.
FindChoicesOptions getRecognizerOptions()

Ruft zusätzliche Optionen ab, die an die zugrunde liegende {@link ChoiceRecognizers#recognizeChoices(String, IList{Choice}, FindChoicesOptions)}-Methode übergeben werden, oder legt diese fest.
ListStyle getStyle()

Ruft die Formatvorlage ab, die beim Präsentieren der Eingabeaufforderung für den Benutzer verwendet werden soll.
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<FoundChoice>> onRecognize(TurnContext turnContext, Map<String,Object> state, PromptOptions options)

Versucht, die Eingabe des Benutzers zu erkennen.
void setChoiceOptions(ChoiceFactoryOptions choiceOptions)

Legt zusätzliche Optionen fest, die an die ChoiceFactory übergeben werden, und wird verwendet, um die Art der Auswahl zu optimieren, die für den Benutzer gerendert wird.
void setDefaultLocale(String defaultLocale)

Legt das Standardgebietsschema fest, das verwendet wird, um das sprachspezifische Verhalten der Eingabeaufforderung zu bestimmen.
void setRecognizerOptions(FindChoicesOptions recognizerOptions)

Ruft zusätzliche Optionen ab, die an die zugrunde liegende {@link ChoiceRecognizers#recognizeChoices(String, IList{Choice}, FindChoicesOptions)}-Methode übergeben werden, oder legt diese fest.
void setStyle(ListStyle style)

Legt die Formatvorlage fest, die beim Darstellen der Eingabeaufforderung für den Benutzer verwendet werden soll.

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

ChoicePrompt

public ChoicePrompt(String dialogId)

Initialisiert eine neue Instanz der ChoicePrompt Klasse.

Parameter:

dialogId - Die ID, die dieser Eingabeaufforderung zugewiesen werden soll.

ChoicePrompt

public ChoicePrompt(String dialogId, PromptValidator validator, String defaultLocale)

Initialisiert eine neue Instanz der ChoicePrompt 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.
defaultLocale - Optional, das Standardgebietsschema, das verwendet wird, um das sprachspezifische Verhalten der Eingabeaufforderung zu bestimmen. Das Gebietsschema ist ein ISO 639-Code mit 2, 3 oder 4 Zeichen, der eine Sprache oder Sprache darstellt. 
                  The value of <xref uid="" data-throw-if-not-resolved="false" data-raw-source="dialogId"></xref> 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. If the <xref uid="com.microsoft.bot.schema.Activity.locale" data-throw-if-not-resolved="false" data-raw-source="Activity#locale"></xref> of
                  the <xref uid="com.microsoft.bot.dialogs.DialogContext" data-throw-if-not-resolved="false" data-raw-source="DialogContext"></xref> .<xref uid="com.microsoft.bot.dialogs.DialogContext.context" data-throw-if-not-resolved="false" data-raw-source="DialogContext#context"></xref>
                  .<xref uid="" data-throw-if-not-resolved="false" data-raw-source="ITurnContext#activity"></xref> is specified, then that
                  local is used to determine language specific behavior;
                  otherwise the <xref uid="" data-throw-if-not-resolved="false" data-raw-source="defaultLocale"></xref> is used. US-English
                  is the used if no language or default locale is
                  available, or if the language or locale is not otherwise
                  supported.

ChoicePrompt

public ChoicePrompt(String dialogId, Map choiceDefaults, PromptValidator validator, String defaultLocale)

Initialisiert eine neue Instanz der ChoicePrompt Klasse.

Parameter:

dialogId - Die ID, die dieser Eingabeaufforderung zugewiesen werden soll.
choiceDefaults - Überschreibt das Wörterbuch des vom Bot Framework SDK unterstützten _choiceDefaults (für die Eingabeaufforderungslokalisierung). Muss an jede ConfirmPrompt übergeben werden, die die Standardeinstellungen für die benutzerdefinierte Auswahl benötigt. Der Wert von dialogId muss innerhalb des DialogSet oder ComponentDialog eindeutig sein, dem die Eingabeaufforderung hinzugefügt wird. Wenn die Activity#locale der DialogContext .DialogContext#context .ITurnContext#activity angegeben wird, wird dann lokal verwendet, um das sprachspezifische Verhalten zu bestimmen; andernfalls wird die defaultLocale verwendet. US-English wird verwendet, wenn keine Sprache oder kein Standardgebietsschema verfügbar ist oder wenn die Sprache oder das Gebietsschema nicht anderweitig unterstützt wird.
validator - Optional, ein {@link PromptValidator{FoundChoice}} mit zusätzlicher, benutzerdefinierter Überprüfung für diese Eingabeaufforderung.
defaultLocale - Optional, das Standardgebietsschema, das verwendet wird, um das sprachspezifische Verhalten der Eingabeaufforderung zu bestimmen. Das Gebietsschema ist ein ISO 639-Code mit 2, 3 oder 4 Zeichen, der eine Sprache oder Sprache darstellt.

Details zur Methode

getChoiceOptions

public ChoiceFactoryOptions getChoiceOptions()

Ruft zusätzliche Optionen ab, die an die ChoiceFactory übergeben und verwendet werden, um die Art der Auswahl zu optimieren, die für den Benutzer gerendert wird.

Gibt zurück:

Zusätzliche Optionen für die Darstellung der Auswahlmöglichkeiten.

getDefaultLocale

public String getDefaultLocale()

Legt das Standardgebietsschema fest, das zum Bestimmen des sprachspezifischen Verhaltens der Eingabeaufforderung verwendet wird, oder legt dieses fest.

Gibt zurück:

Das Standardgebietsschema, das verwendet wird, um das sprachspezifische Verhalten der Eingabeaufforderung zu bestimmen.

getRecognizerOptions

public FindChoicesOptions getRecognizerOptions()

Ruft zusätzliche Optionen ab, die an die zugrunde liegende {@link ChoiceRecognizers#recognizeChoices(String, IList{Choice}, FindChoicesOptions)}-Methode übergeben werden, oder legt diese fest.

Gibt zurück:

Optionen zum Steuern der Erkennungsstrategie.

getStyle

public ListStyle getStyle()

Ruft die Formatvorlage ab, die beim Präsentieren der Eingabeaufforderung für den Benutzer verwendet werden soll.

Gibt zurück:

Die Formatvorlage, die beim Präsentieren der Eingabeaufforderung für den Benutzer verwendet werden soll.

onPrompt

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

Fordert den Benutzer zur Eingabe auf.

Überschreibt:

ChoicePrompt.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:

ChoicePrompt.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.

setChoiceOptions

public void setChoiceOptions(ChoiceFactoryOptions choiceOptions)

Legt zusätzliche Optionen fest, die an die ChoiceFactory übergeben werden, und wird verwendet, um die Art der Auswahl zu optimieren, die für den Benutzer gerendert wird.

Parameter:

choiceOptions - Zusätzliche Optionen für die Darstellung der Auswahlmöglichkeiten.

setDefaultLocale

public void setDefaultLocale(String defaultLocale)

Legt das Standardgebietsschema fest, das verwendet wird, um das sprachspezifische Verhalten der Eingabeaufforderung zu bestimmen.

Parameter:

defaultLocale - Das Standardgebietsschema, das verwendet wird, um das sprachspezifische Verhalten der Eingabeaufforderung zu bestimmen.

setRecognizerOptions

public void setRecognizerOptions(FindChoicesOptions recognizerOptions)

Ruft zusätzliche Optionen ab, die an die zugrunde liegende {@link ChoiceRecognizers#recognizeChoices(String, IList{Choice}, FindChoicesOptions)}-Methode übergeben werden, oder legt diese fest.

Parameter:

recognizerOptions - Optionen zum Steuern der Erkennungsstrategie.

setStyle

public void setStyle(ListStyle style)

Legt die Formatvorlage fest, die beim Darstellen der Eingabeaufforderung für den Benutzer verwendet werden soll.

Parameter:

style - Die Formatvorlage, die beim Präsentieren der Eingabeaufforderung für den Benutzer verwendet werden soll.

Gilt für: