Freigeben über

ChoicePrompt class

  • Referenz
Paket:
botbuilder-dialogs

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

Extends

Prompt<FoundChoice>

Hinweise

Standardmäßig kehrt die Eingabeaufforderung zum aufrufenden Dialogfeld ein FoundChoice Objekt zurück, das die ausgewählte Auswahl enthält.

Konstruktoren

ChoicePrompt(string, PromptValidator<FoundChoice>, string, ChoiceDefaultsChoicePrompt)

Erstellt eine neue ChoicePrompt Instanz.

Eigenschaften

choiceOptions

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

Das Standardgebietsschema der Eingabeaufforderungen, das erkannt werden soll.
id

Eindeutige ID des Dialogfelds. Legt die eindeutige ID des Dialogfelds fest.
recognizerOptions

Weitere Optionen, die an die zugrunde liegende recognizeChoices()-Funktion übergeben werden.
style

Stil der "Ja"- und "Nein"-Auswahl, die beim Eingabeaufforderung für den Benutzer gerendert wird.
telemetryClient

Ruft den Telemetrieclient für dieses Dialogfeld ab. Legt den Telemetrieclient für dieses Dialogfeld fest.

Geerbte Eigenschaften

EndOfTurn

Ruft ein Standardmäßiges End-of-Turn-Ergebnis ab.

Geerbte Methoden

beginDialog(DialogContext, PromptOptions)

Wird aufgerufen, wenn ein Eingabeaufforderungsdialogfeld auf den Dialogstapel verschoben wird und aktiviert wird.
configure(Record<string, unknown>)

Fluent-Methode zum Konfigurieren des Objekts.
continueDialog(DialogContext)

Wird aufgerufen, wenn ein Eingabeaufforderungsdialogfeld das aktive Dialogfeld ist und der Benutzer mit einer neuen Aktivität geantwortet hat.
endDialog(TurnContext, DialogInstance, DialogReason)

Wenn sie in einer abgeleiteten Klasse überschrieben wird, wird das Dialogfeld vor dem Beenden bereinigt.
getConverter(string)
getVersion()

Eine codierte Zeichenfolge zur Unterstützung der Erkennung von Bot-Änderungen bei der erneuten Bereitstellung.
onDialogEvent(DialogContext, DialogEvent)

Wird aufgerufen, wenn ein Ereignis mit DialogContext.emitEvent()ausgelöst wurde, entweder durch das aktuelle Dialogfeld oder ein Dialogfeld, das das aktuelle Dialogfeld gestartet hat.
repromptDialog(TurnContext, DialogInstance)

Wird aufgerufen, wenn ein Eingabeaufforderungsdialogfeld aufgefordert wurde, den Benutzer erneut zur Eingabe aufzufordern.
resumeDialog(DialogContext, DialogReason, any)

Wird aufgerufen, wenn ein Eingabeaufforderungsdialogfeld wieder das aktive Dialogfeld im Dialogstapel ist, z. B. wenn das vorherige aktive Dialogfeld im Stapel abgeschlossen ist.

Details zum Konstruktor

ChoicePrompt(string, PromptValidator<FoundChoice>, string, ChoiceDefaultsChoicePrompt)

Erstellt eine neue ChoicePrompt Instanz.

new ChoicePrompt(dialogId: string, validator?: PromptValidator<FoundChoice>, defaultLocale?: string, choiceDefaults?: ChoiceDefaultsChoicePrompt)

Parameter

dialogId

string

Eindeutige ID des Dialogfelds innerhalb des übergeordneten DialogSet.

validator

PromptValidator<FoundChoice>

(Optional) Validator, der jedes Mal aufgerufen wird, wenn der Benutzer auf die Eingabeaufforderung antwortet. Wenn der Validator mit einer Nachricht antwortet, wird keine zusätzliche Wiederholungsaufforderung gesendet.

defaultLocale

string

(Optional) Gebietsschema, das verwendet werden soll, wenn dc.context.activity.locale nicht angegeben ist. Der Standardwert ist ein Wert von en-us.

choiceDefaults
ChoiceDefaultsChoicePrompt

(Optional) Ü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.

Details zur Eigenschaft

choiceOptions

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

choiceOptions: ChoiceFactoryOptions | undefined

Eigenschaftswert

ChoiceFactoryOptions | undefined

defaultLocale

Das Standardgebietsschema der Eingabeaufforderungen, das erkannt werden soll.

defaultLocale: string | undefined

Eigenschaftswert

string | undefined

id

Eindeutige ID des Dialogfelds. Legt die eindeutige ID des Dialogfelds fest.

string id

Eigenschaftswert

string

Die ID für das Dialogfeld.

Hinweise

Dies wird automatisch generiert, wenn nicht angegeben.

recognizerOptions

Weitere Optionen, die an die zugrunde liegende recognizeChoices()-Funktion übergeben werden.

recognizerOptions: FindChoicesOptions | undefined

Eigenschaftswert

FindChoicesOptions | undefined

style

Stil der "Ja"- und "Nein"-Auswahl, die beim Eingabeaufforderung für den Benutzer gerendert wird.

style: ListStyle

Eigenschaftswert

ListStyle

Hinweise

Der Standardwert lautet ListStyle.auto.

telemetryClient

Ruft den Telemetrieclient für dieses Dialogfeld ab. Legt den Telemetrieclient für dieses Dialogfeld fest.

BotTelemetryClient telemetryClient

Eigenschaftswert

BotTelemetryClient

Der BotTelemetryClient für die Protokollierung verwendet werden.

Geerbte Eigenschaftsdetails

EndOfTurn

Ruft ein Standardmäßiges End-of-Turn-Ergebnis ab.

static EndOfTurn: DialogTurnResult

Eigenschaftswert

DialogTurnResult

Hinweise

Dieses Ergebnis gibt an, dass ein Dialogfeld (oder ein logischer Schritt innerhalb eines Dialogfelds) die Verarbeitung für die aktuelle Drehung abgeschlossen hat, noch aktiv ist und auf weitere Eingaben wartet.

vonDialog.EndOfTurn geerbt

Details zur geerbten Methode

beginDialog(DialogContext, PromptOptions)

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

function beginDialog(dc: DialogContext, options: PromptOptions): Promise<DialogTurnResult>

Parameter

dc
DialogContext

Die DialogContext- für die aktuelle Unterhaltung.

options
PromptOptions

Wahlfrei. PromptOptions-, zusätzliche Informationen, die an die zu startende Eingabeaufforderung übergeben werden sollen.

Gibt zurück

Promise<DialogTurnResult>

Eine Promise, die den asynchronen Vorgang darstellt.

Hinweise

Wenn der Vorgang erfolgreich ist, gibt das Ergebnis an, ob die Eingabeaufforderung noch aktiv ist, nachdem die Aufforderung von der Eingabeaufforderung verarbeitet wurde.

geerbt vonPrompt.beginDialog-

configure(Record<string, unknown>)

Fluent-Methode zum Konfigurieren des Objekts.

function configure(config: Record<string, unknown>): this

Parameter

config

Record<string, unknown>

Anzuwendende Konfigurationseinstellungen.

Gibt zurück

this

Die konfigurierbaren nach Abschluss des Vorgangs.

geerbt vonKonfigurierbar.configure

continueDialog(DialogContext)

Wird aufgerufen, wenn ein Eingabeaufforderungsdialogfeld das aktive Dialogfeld ist und der Benutzer mit einer neuen Aktivität geantwortet hat.

function continueDialog(dc: DialogContext): Promise<DialogTurnResult>

Parameter

dc
DialogContext

Die DialogContext- für die aktuelle Unterhaltungswende.

Gibt zurück

Promise<DialogTurnResult>

Eine Promise, die den asynchronen Vorgang darstellt.

Hinweise

Wenn die Aufgabe erfolgreich ist, gibt das Ergebnis an, ob das Dialogfeld noch aktiv ist, nachdem die Drehung vom Dialogfeld verarbeitet wurde. Die Eingabeaufforderung empfängt in der Regel weiterhin die Antworten des Benutzers, bis sie die Antwort des Benutzers als gültige Eingabe für die Eingabeaufforderung akzeptiert.

Geerbt vonPrompt.continueDialog-

endDialog(TurnContext, DialogInstance, DialogReason)

Wenn sie in einer abgeleiteten Klasse überschrieben wird, wird das Dialogfeld vor dem Beenden bereinigt.

function endDialog(_context: TurnContext, _instance: DialogInstance, _reason: DialogReason): Promise<void>

Parameter

_context

TurnContext

Das Kontextobjekt für die Drehung.

_instance
DialogInstance

Aktuelle Statusinformationen für dieses Dialogfeld.

_reason
DialogReason

Der Grund, warum das Dialogfeld beendet wird.

Gibt zurück

Promise<void>

Hinweise

Abgeleitete Dialogfelder, die vor dem Beenden Protokollierung oder Bereinigung durchführen müssen, sollten diese Methode überschreiben. Standardmäßig hat diese Methode keine Auswirkung.

Die DialogContext- ruft diese Methode auf, wenn das aktuelle Dialogfeld beendet wird.

Siehe auch

vonDialog.endDialog geerbt

getConverter(string) 

function getConverter(_property: string): Converter | ConverterFactory

Parameter

_property

string

Der Schlüssel der Konfiguration der bedingten Auswahl.

Gibt zurück

Converter | ConverterFactory

Der Konverter für die Selektorkonfiguration.

Geerbt vonKonfigurierbar.getConverter

getVersion()

Eine codierte Zeichenfolge zur Unterstützung der Erkennung von Bot-Änderungen bei der erneuten Bereitstellung.

function getVersion(): string

Gibt zurück

string

Eindeutige Zeichenfolge, die sich nur ändern sollte, wenn sich das Dialogfeld auf eine Weise geändert hat, die das Dialogfeld neu starten soll.

Hinweise

Dadurch werden standardmäßig die Dialogfelder ID- zurückgegeben, können jedoch außer Kraft gesetzt werden, um präzisere Änderungserkennungslogik bereitzustellen. Jedes Dialogfeld im Stapel, das seine Versionsänderung hat, führt zu einem versionChanged Ereignis wird ausgelöst. Wenn dieses Ereignis nicht vom Bot behandelt wird, wird ein Fehler ausgelöst, der dazu führt, dass die Bots-Fehlerhandlerlogik ausgeführt wird.

Durch zurückgeben einer leeren Zeichenfolge wird die Versionsnachverfolgung für die Komponente insgesamt deaktiviert.

geerbt vonDialog.getVersion

onDialogEvent(DialogContext, DialogEvent)

Wird aufgerufen, wenn ein Ereignis mit DialogContext.emitEvent()ausgelöst wurde, entweder durch das aktuelle Dialogfeld oder ein Dialogfeld, das das aktuelle Dialogfeld gestartet hat.

function onDialogEvent(dc: DialogContext, e: DialogEvent): Promise<boolean>

Parameter

dc
DialogContext

Der Dialogkontext für die aktuelle Unterhaltungswende.

e
DialogEvent

Das ausgelöste Ereignis.

Gibt zurück

Promise<boolean>

True, wenn das Ereignis vom aktuellen Dialogfeld behandelt wird und Bubbling beendet werden soll.

geerbt vonDialog.onDialogEvent

repromptDialog(TurnContext, DialogInstance)

Wird aufgerufen, wenn ein Eingabeaufforderungsdialogfeld aufgefordert wurde, den Benutzer erneut zur Eingabe aufzufordern.

function repromptDialog(context: TurnContext, instance: DialogInstance): Promise<void>

Parameter

context

TurnContext

(xref:botbuilder-core. TurnContext), Kontext für die aktuelle Unterhaltungswende mit dem Benutzer.

instance
DialogInstance

(xref:botbuilder-dialogs. DialogInstance), die Instanz des Dialogfelds im Stapel.

Gibt zurück

Promise<void>

Eine Promise, die den asynchronen Vorgang darstellt.

geerbt vonPrompt.repromptDialog-

resumeDialog(DialogContext, DialogReason, any)

Wird aufgerufen, wenn ein Eingabeaufforderungsdialogfeld wieder das aktive Dialogfeld im Dialogstapel ist, z. B. wenn das vorherige aktive Dialogfeld im Stapel abgeschlossen ist.

function resumeDialog(dc: DialogContext, _reason: DialogReason, _result?: any): Promise<DialogTurnResult>

Parameter

dc
DialogContext

Der DialogContext für die aktuelle Wendung der Unterhaltung.

_reason
DialogReason

Eine Enumeration, die angibt, warum das Dialogfeld fortgesetzt wurde.

_result

any

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

Promise<DialogTurnResult>

Eine Zusage, die den asynchronen Vorgang darstellt.

Hinweise

Wenn die Aufgabe erfolgreich ist, gibt das Ergebnis an, ob das Dialogfeld noch aktiv ist, nachdem die Drehung vom Dialogfeld verarbeitet wurde.

Geerbt vonPrompt.resumeDialog