DialogContainer class
Ein Container für eine Reihe von Dialogfeldern.
- Extends
-
Dialog<O>
Konstruktoren
| Dialog |
Erstellt eine neue Instanz der Dialog Klasse. |
Eigenschaften
| dialogs | Das Dialogfeld "Container" wird festgelegt. |
| id | Eindeutige ID des Dialogfelds. Legt die eindeutige ID des Dialogfelds fest. |
| telemetry |
Legen Sie den Telemetrieclient fest, und wenden Sie ihn auch auf alle untergeordneten Dialogfelder an. Zukünftige Dialogfelder, die der Komponente hinzugefügt werden, erben ebenfalls diesen Client. Rufen Sie den aktuellen Telemetrieclient ab. |
Geerbte Eigenschaften
| End |
Ruft ein Standardmäßiges End-of-Turn-Ergebnis ab. |
Methoden
| create |
Erstellt einen inneren Dialogkontext für die Container, die untergeordnete Container sind. |
| find |
Sucht ein untergeordnetes Dialogfeld, das zuvor dem Container hinzugefügt wurde. |
| on |
Wird aufgerufen, wenn ein Ereignis mit |
Geerbte Methoden
| begin |
Wenn sie in einer abgeleiteten Klasse überschrieben wird, wird das Dialogfeld gestartet. |
| configure(Record<string, unknown>) | Fluent-Methode zum Konfigurieren des Objekts. |
| continue |
Wenn sie in einer abgeleiteten Klasse überschrieben wird, wird das Dialogfeld fortgesetzt. |
| 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. |
| reprompt |
Wenn sie in einer abgeleiteten Klasse überschrieben wird, wird der Benutzer erneut zur Eingabe aufgefordert. |
| resume |
Wenn sie in einer abgeleiteten Klasse überschrieben wird, wird das Dialogfeld nach Abschluss des Dialogfelds auf dem Stapel fortgesetzt. |
Details zum Konstruktor
DialogContainer(string)
Erstellt eine neue Instanz der Dialog Klasse.
new DialogContainer(dialogId?: string)Parameter
- dialogId
-
string
Wahlfrei. eindeutige ID des Dialogfelds.
Details zur Eigenschaft
dialogs
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
Legen Sie den Telemetrieclient fest, und wenden Sie ihn auch auf alle untergeordneten Dialogfelder an. Zukünftige Dialogfelder, die der Komponente hinzugefügt werden, erben ebenfalls diesen Client. Rufen Sie den aktuellen Telemetrieclient ab.
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
createChildContext(DialogContext)
Erstellt einen inneren Dialogkontext für die Container, die untergeordnete Container sind.
function createChildContext(dc: DialogContext): DialogContext | undefinedParameter
Kontext des Dialogfelds "Eltern".
Gibt zurück
DialogContext | undefined
Ein neuer Dialogfeldkontext für das aktive untergeordnete Element oder undefined, wenn kein aktives untergeordnetes Element vorhanden ist.
findDialog(string)
Sucht ein untergeordnetes Dialogfeld, das zuvor dem Container hinzugefügt wurde.
function findDialog(dialogId: string): Dialog | undefinedParameter
- dialogId
-
string
ID des zu suchenden Dialogfelds.
Gibt zurück
Dialog | undefined
Das Dialogfeld, falls gefunden; andernfalls NULL.
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.
Details zur geerbten Methode
beginDialog(DialogContext, O)
Wenn sie in einer abgeleiteten Klasse überschrieben wird, wird das Dialogfeld gestartet.
function beginDialog(dc: DialogContext, options?: O): Promise<DialogTurnResult>Parameter
Der Kontext für die aktuelle Dialogdrehung.
- options
-
O
Wahlfrei. Argumente, die verwendet werden sollen, wenn das Dialogfeld gestartet wird.
Gibt zurück
Promise<DialogTurnResult>
Hinweise
Abgeleitete Dialogfelder müssen diese Methode überschreiben.
Die DialogContext- ruft diese Methode auf, wenn sie eine neue DialogInstance- für dieses Dialogfeld erstellt, sie in den Dialogstapel überträgt und das Dialogfeld startet.
Ein Dialogfeld, das eine Einzelunterhaltung darstellt, sollte DialogContext.endDialog warten, bevor sie diese Methode beenden.
Siehe auch
geerbt vonDialog.beginDialog
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
continueDialog(DialogContext)
Wenn sie in einer abgeleiteten Klasse überschrieben wird, wird das Dialogfeld fortgesetzt.
function continueDialog(dc: DialogContext): Promise<DialogTurnResult>Parameter
Der Kontext für die aktuelle Dialogdrehung.
Gibt zurück
Promise<DialogTurnResult>
Eine Zusage, die in das Dialogdrehergebnis aufgelöst wird.
Hinweise
Abgeleitete Dialogfelder, die Mehrfachwechselunterhaltungen unterstützen, sollten diese Methode überschreiben. Standardmäßig signalisiert diese Methode, dass das Dialogfeld abgeschlossen ist und zurückgegeben wird.
Die DialogContext- ruft diese Methode auf, wenn das Dialogfeld fortgesetzt wird.
Um dem Dialogfeldkontext zu signalisieren, dass dieses Dialogfeld abgeschlossen wurde, warten Sie DialogContext.endDialog, bevor Sie diese Methode beenden.
Siehe auch
Geerbt vonDialog.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
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
repromptDialog(TurnContext, DialogInstance)
Wenn sie in einer abgeleiteten Klasse überschrieben wird, wird der Benutzer erneut zur Eingabe aufgefordert.
function repromptDialog(_context: TurnContext, _instance: DialogInstance): Promise<void>Parameter
- _context
-
TurnContext
Das Kontextobjekt für die Drehung.
- _instance
- DialogInstance
Aktuelle Statusinformationen für dieses Dialogfeld.
Gibt zurück
Promise<void>
Hinweise
Abgeleitete Dialogfelder, die validierungs- und erneute Aufforderungslogik unterstützen, sollten diese Methode überschreiben. Standardmäßig hat diese Methode keine Auswirkung.
Die DialogContext- ruft diese Methode auf, wenn das aktuelle Dialogfeld eingaben vom Benutzer erneut anfordern soll. Diese Methode wird für Eingabeaufforderungsdialoge implementiert.
Siehe auch
geerbt vonDialog.repromptDialog-
resumeDialog(DialogContext, DialogReason, any)
Wenn sie in einer abgeleiteten Klasse überschrieben wird, wird das Dialogfeld nach Abschluss des Dialogfelds auf dem Stapel fortgesetzt.
function resumeDialog(dc: DialogContext, reason: DialogReason, result?: any): Promise<DialogTurnResult>Parameter
Der Kontext für die aktuelle Dialogdrehung.
- reason
- DialogReason
Der Grund, warum das Dialogfeld fortgesetzt wird. Dies wird in der Regel DialogReason.endCalled-
- result
-
any
Wahlfrei. Der Rückgabewert (falls vorhanden) aus dem dialogfeld, das beendet wurde.
Gibt zurück
Promise<DialogTurnResult>
Eine Zusage, die in das Dialogdrehergebnis aufgelöst wird.
Hinweise
Abgeleitete Dialogfelder, die Mehrfachwechselunterhaltungen unterstützen, sollten diese Methode überschreiben. Standardmäßig signalisiert diese Methode, dass das Dialogfeld abgeschlossen ist und zurückgegeben wird.
Die DialogContext- ruft diese Methode auf, wenn das Dialogfeld fortgesetzt wird. Wenn das vorherige Dialogfeld im Stapel einen Wert zurückgegeben hat, befindet sich dieser Wert im result-Parameter.
Um ein untergeordnetes dialogfeld zu starten, verwenden Sie DialogContext.beginDialog oder DialogContext.prompt; Dieses Dialogfeld ist jedoch nicht unbedingt das Dialogfeld, das das untergeordnete Dialogfeld gestartet hat. Um dem Dialogfeldkontext zu signalisieren, dass dieses Dialogfeld abgeschlossen wurde, warten Sie DialogContext.endDialog, bevor Sie diese Methode beenden.
Siehe auch
geerbt vonDialog.resumeDialog