DateTimePrompt Klasse

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

public class DateTimePrompt
extends Prompt<java.util.List<DateTimeResolution>>

Fordert einen Benutzer auf, einen Datums-/Uhrzeitwert einzufordern.

Zusammenfassung zum Konstruktor

Konstruktor Beschreibung
DateTimePrompt(String dialogId, PromptValidator<List<DateTimeResolution>> validator, String defaultLocale)

Initialisiert eine neue Instanz der DateTimePrompt Klasse.

Methodenzusammenfassung

Modifizierer und Typ Methode und Beschreibung
java.lang.String getDefaultLocale()

Ruft das Standardgebietsschema ab, das zum Bestimmen des sprachspezifischen Verhaltens der Eingabeaufforderung verwendet 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.util.List<DateTimeResolution>>> onRecognize(TurnContext turnContext, Map<String,Object> state, PromptOptions options)

Versucht, die Eingabe des Benutzers als Datums-/Uhrzeitwert zu erkennen.
void setDefaultLocale(String defaultLocale)

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

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

DateTimePrompt

public DateTimePrompt(String dialogId, PromptValidator> validator, String defaultLocale)

Initialisiert eine neue Instanz der DateTimePrompt Klasse.

Parameter:

dialogId - Die ID, die dieser Eingabeaufforderung zugewiesen werden soll.
validator - Optional, eine PromptValidator.FoundChoice, die zusätzliche, benutzerdefinierte Überprüfung für diese Eingabeaufforderung enthält.
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.

Details zur Methode

getDefaultLocale

public String getDefaultLocale()

Ruft das Standardgebietsschema ab, das zum Bestimmen des sprachspezifischen Verhaltens der Eingabeaufforderung verwendet wird.

Gibt zurück:

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

onPrompt

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

Fordert den Benutzer zur Eingabe auf.

Überschreibt:

DateTimePrompt.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 als Datums-/Uhrzeitwert zu erkennen.

Überschreibt:

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

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.

Gilt für: