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 Standardergebnis ab. |
Methoden
| begin |
Wird aufgerufen, wenn ein Eingabeaufforderungsdialogfeld auf den Dialogstapel gepusht und aktiviert wird. |
| continue |
Wird aufgerufen, wenn ein Eingabeaufforderungsdialogfeld der aktive Dialog ist und der Benutzer mit einer neuen Aktivität geantwortet hat. |
| reprompt |
Wird aufgerufen, wenn ein Eingabeaufforderungsdialogfeld angefordert wurde, um den Benutzer erneut zur Eingabe aufzufordern. |
| resume |
Wird aufgerufen, wenn ein Eingabeaufforderungsdialog wieder der aktive Dialog im Dialogstapel ist, z. B. wenn der vorherige aktive Dialog im Stapel abgeschlossen ist. |
Geerbte Methoden
| configure(Record<string, unknown>) | Fluent-Methode zum Konfigurieren des Objekts. |
| end |
Führt beim Überschreiben in einer abgeleiteten Klasse eine Bereinigung für den Dialog aus, bevor es beendet wird. |
| get |
|
| get |
Eine codierte Zeichenfolge, die bei der Erkennung von Botänderungen bei der erneuten Bereitstellung verwendet wird. |
| on |
Wird aufgerufen, wenn ein Ereignis mithilfe von ausgelöst wurde, |
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 , der für die Protokollierung verwendet werden soll.
Geerbte Eigenschaftsdetails
EndOfTurn
Ruft ein Standardergebnis ab.
static EndOfTurn: DialogTurnResultEigenschaftswert
Hinweise
Dieses Ergebnis gibt an, dass ein Dialog (oder ein logischer Schritt innerhalb eines Dialogs) die Verarbeitung für den aktuellen Turn abgeschlossen hat, noch aktiv ist und auf weitere Eingaben wartet.
Geerbt vonDialog.EndOfTurn
Details zur Methode
beginDialog(DialogContext, PromptOptions)
Wird aufgerufen, wenn ein Eingabeaufforderungsdialogfeld auf den Dialogstapel gepusht und aktiviert wird.
function beginDialog(dc: DialogContext, options: PromptOptions): Promise<DialogTurnResult>Parameter
Der DialogContext für den aktuellen Turn der Unterhaltung.
- options
- PromptOptions
Optional. PromptOptions, zusätzliche Informationen, die an die gestartete Eingabeaufforderung übergeben werden sollen.
Gibt zurück
Promise<DialogTurnResult>
Eine Promise, die den asynchronen Vorgang darstellt
Hinweise
Wenn die Aufgabe erfolgreich ist, gibt das Ergebnis an, ob die Eingabeaufforderung weiterhin aktiv ist, nachdem der Turn von der Eingabeaufforderung verarbeitet wurde.
continueDialog(DialogContext)
Wird aufgerufen, wenn ein Eingabeaufforderungsdialogfeld der aktive Dialog ist und der Benutzer mit einer neuen Aktivität geantwortet hat.
function continueDialog(dc: DialogContext): Promise<DialogTurnResult>Parameter
Der DialogContext für den aktuellen Unterhaltungswechsel.
Gibt zurück
Promise<DialogTurnResult>
Eine Promise, die den asynchronen Vorgang darstellt
Hinweise
Wenn die Aufgabe erfolgreich ist, gibt das Ergebnis an, ob der Dialog nach der Verarbeitung durch den Dialog noch aktiv ist. Die Eingabeaufforderung empfängt im Allgemeinen 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 angefordert wurde, um den Benutzer erneut zur Eingabe aufzufordern.
function repromptDialog(context: TurnContext, instance: DialogInstance): Promise<void>Parameter
- context
-
TurnContext
(xref:botbuilder-core. TurnContext), Kontext für den aktuellen Gesprächswechsel mit dem Benutzer.
- instance
- DialogInstance
(xref:botbuilder-dialogs. DialogInstance), die Instanz des Dialogs im Stapel.
Gibt zurück
Promise<void>
Eine Promise, die den asynchronen Vorgang darstellt
resumeDialog(DialogContext, DialogReason, any)
Wird aufgerufen, wenn ein Eingabeaufforderungsdialog wieder der aktive Dialog im Dialogstapel ist, z. B. wenn der vorherige aktive Dialog im Stapel abgeschlossen ist.
function resumeDialog(dc: DialogContext, _reason: DialogReason, _result?: any): Promise<DialogTurnResult>Parameter
Der DialogContext für den aktuellen Turn der Unterhaltung.
- _reason
- DialogReason
Eine Enumeration, die angibt, warum der Dialog fortgesetzt wurde.
- _result
-
any
Optionaler Wert, der aus dem vorherigen Dialogfeld im Stapel zurückgegeben wurde. 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 der Dialog nach der Verarbeitung durch den Dialog noch aktiv ist.
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>
Zu übernehmende Konfigurationseinstellungen.
Gibt zurück
this
Die Konfigurierbare nach Abschluss des Vorgangs.
Geerbt vonConfigure.configure
endDialog(TurnContext, DialogInstance, DialogReason)
Führt beim Überschreiben in einer abgeleiteten Klasse eine Bereinigung für den Dialog aus, bevor es beendet wird.
function endDialog(_context: TurnContext, _instance: DialogInstance, _reason: DialogReason): Promise<void>Parameter
- _context
-
TurnContext
Das Kontextobjekt für den Turn.
- _instance
- DialogInstance
Aktuelle Statusinformationen für dieses Dialogfeld.
- _reason
- DialogReason
Der Grund, warum das Dialogfeld beendet wird.
Gibt zurück
Promise<void>
Hinweise
Abgeleitete Dialoge, die vor dem Beenden protokollierungs- oder bereinigungsvorgängen müssen, sollten diese Methode außer Kraft setzen. Standardmäßig hat diese Methode keine Auswirkungen.
DialogContext ruft diese Methode auf, wenn der aktuelle Dialog beendet wird.
Weitere Informationen
Geerbt vonDialog.endDialog
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 vonConfigurable.getConverter
getVersion()
Eine codierte Zeichenfolge, die bei der Erkennung von Botänderungen bei der erneuten Bereitstellung verwendet wird.
function getVersion(): stringGibt zurück
string
Eindeutige Zeichenfolge, die sich nur ändern sollte, wenn sich das Dialogfeld so geändert hat, dass der Dialog neu gestartet werden soll.
Hinweise
Dies gibt standardmäßig die Dialog-ID zurück, kann jedoch überschrieben werden, um eine präzisere Änderungserkennungslogik bereitzustellen. Jedes Dialogfeld auf dem Stapel, dessen Version geändert wird, führt dazu, dass ein versionChanged Ereignis ausgelöst wird. Wenn dieses Ereignis nicht vom Bot behandelt wird, wird ein Fehler ausgelöst, der dazu führt, dass die Fehlerhandlerlogik des Bots ausgeführt wird.
Wenn Sie eine leere Zeichenfolge zurückgeben, wird die Versionsnachverfolgung für die Komponente insgesamt deaktiviert.
Geerbt vonDialog.getVersion
onDialogEvent(DialogContext, DialogEvent)
Wird aufgerufen, wenn ein Ereignis mithilfe von ausgelöst wurde, DialogContext.emitEvent()entweder durch den aktuellen Dialog oder einen Dialog, den der aktuelle Dialog gestartet hat.
function onDialogEvent(dc: DialogContext, e: DialogEvent): Promise<boolean>Parameter
Der Dialogkontext für den aktuellen Unterhaltungswechsel.
Das ausgelöste Ereignis.
Gibt zurück
Promise<boolean>
True, wenn das Ereignis vom aktuellen Dialogfeld behandelt wird und das Sprudeln beendet werden soll.
Geerbt vonDialog.onDialogEvent