Prompt class
Basisklasse für alle Eingabeaufforderungen.
- Extends
Eigenschaften
| id | Eindeutige ID des Dialogfelds. Legt die eindeutige ID des Dialogfelds fest. |
| telemetry |
Ruft den Telemetrieclient für dieses Dialogfeld ab. Legt den Telemetrieclient für dieses Dialogfeld fest. |
Geerbte Eigenschaften
| End |
Ruft ein Standardmäßiges End-of-Turn-Ergebnis ab. |
Methoden
| begin |
Wird aufgerufen, wenn ein Eingabeaufforderungsdialogfeld auf den Dialogstapel verschoben wird und aktiviert wird. |
| continue |
Wird aufgerufen, wenn ein Eingabeaufforderungsdialogfeld das aktive Dialogfeld ist und der Benutzer mit einer neuen Aktivität geantwortet hat. |
| reprompt |
Wird aufgerufen, wenn ein Eingabeaufforderungsdialogfeld aufgefordert wurde, den Benutzer erneut zur Eingabe aufzufordern. |
| resume |
Wird aufgerufen, wenn ein Eingabeaufforderungsdialogfeld wieder das aktive Dialogfeld im Dialogstapel ist, z. B. wenn das vorherige aktive Dialogfeld im Stapel abgeschlossen ist. |
Geerbte Methoden
| configure(Record<string, unknown>) | Fluent-Methode zum Konfigurieren des Objekts. |
| end |
Wenn sie in einer abgeleiteten Klasse überschrieben wird, wird das Dialogfeld vor dem Beenden bereinigt. |
| get |
|
| get |
Eine codierte Zeichenfolge zur Unterstützung der Erkennung von Bot-Änderungen bei der erneuten Bereitstellung. |
| on |
Wird aufgerufen, wenn ein Ereignis mit |
Details zur Eigenschaft
id
Eindeutige ID des Dialogfelds. Legt die eindeutige ID des Dialogfelds fest.
string idEigenschaftswert
string
Die ID für das Dialogfeld.
Hinweise
Dies wird automatisch generiert, wenn nicht angegeben.
telemetryClient
Ruft den Telemetrieclient für dieses Dialogfeld ab. Legt den Telemetrieclient für dieses Dialogfeld fest.
BotTelemetryClient telemetryClientEigenschaftswert
BotTelemetryClient
Der BotTelemetryClient für die Protokollierung verwendet werden.
Geerbte Eigenschaftsdetails
EndOfTurn
Ruft ein Standardmäßiges End-of-Turn-Ergebnis ab.
static EndOfTurn: DialogTurnResultEigenschaftswert
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.
Details zur 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
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.
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
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.
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.
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
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.
Details zur geerbten Methode
configure(Record<string, unknown>)
Fluent-Methode zum Konfigurieren des Objekts.
function configure(config: Record<string, unknown>): thisParameter
- config
-
Record<string, unknown>
Anzuwendende Konfigurationseinstellungen.
Gibt zurück
this
Die konfigurierbaren nach Abschluss des Vorgangs.
geerbt vonKonfigurierbar.configure
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
getConverter(string)
function getConverter(_property: string): Converter | ConverterFactoryParameter
- _property
-
string
Der Schlüssel der Konfiguration der bedingten Auswahl.
Gibt zurück
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(): stringGibt 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
Der Dialogkontext für die aktuelle Unterhaltungswende.
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