BeginDialog class

Erstellt eine neue BeginDialog Instanz.

new BeginDialog(dialogIdToCall: string, options?: O)

Parameter

static $kind: string

Eigenschaftswert

Ein optionaler Ausdruck, der bei "true" diese Aktion deaktiviert.

disabled?: BoolExpression

Eigenschaftswert

(Optional) Eigenschaftspfad zum Speichern des Dialogfeldergebnisses.

resultProperty?: StringExpression

Eigenschaftswert

Ein Wert, der angibt, ob das neue Dialogfeld die Aktivität verarbeiten soll.

activityProcessed: BoolExpression

Eigenschaftswert

geerbt vonBaseInvokeDialog.activityProcessed

Das dialogfeld, das aufgerufen werden soll.

dialog: DialogExpression

Eigenschaftswert

VonBaseInvokeDialog.dialog geerbt

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

static EndOfTurn: DialogTurnResult

Eigenschaftswert

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.

von Dialog.EndOfTurn geerbt

id: string

Eigenschaftswert

geerbt von Dialog.id

Konfigurierbare Optionen für das Dialogfeld.

options: ObjectExpression<object>

Eigenschaftswert

vonBaseInvokeDialog.options geerbt

telemetryClient: BotTelemetryClient

Eigenschaftswert

Geerbt von Dialog.telemetryClient

Wird aufgerufen, wenn das Dialogfeld gestartet und in den Dialogstapel verschoben wird.

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

Parameter

Gibt zurück

Eine Promise, die den asynchronen Vorgang darstellt.

function getConverter(property: Object): Converter | ConverterFactory

Parameter

Gibt zurück

Der Konverter für die Selektorkonfiguration.

Wird aufgerufen, wenn ein untergeordnetes Dialog seine Drehung abgeschlossen hat, und gibt das Steuerelement zu diesem Dialogfeld zurück.

function resumeDialog(dc: DialogContext, reason: DialogReason, result?: any): Promise<DialogTurnResult>

Parameter

Gibt zurück

Eine Promise, die den asynchronen Vorgang darstellt.

Fluent-Methode zum Konfigurieren des Objekts.

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

Parameter

Gibt zurück

Die konfigurierbaren nach Abschluss des Vorgangs.

Geerbt von Konfigurierbar.configure

Wenn sie in einer abgeleiteten Klasse überschrieben wird, wird das Dialogfeld fortgesetzt.

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

Parameter

Gibt zurück

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

• DialogContext.continueDialog

Geerbt von Dialog.continueDialog

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

Gibt zurück

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

• DialogContext.cancelAllDialogs
• DialogContext.endDialog-
• DialogContext.replaceDialog

von Dialog.endDialog geerbt

Ruft das untergeordnete Dialog Abhängigkeiten ab, damit sie den Containern Dialog festgelegt werden können.

function getDependencies(): Dialog<__type>[]

Gibt zurück

Das untergeordnete Dialog Abhängigkeiten.

geerbt vonBaseInvokeDialog.getDependencies

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

function getVersion(): string

Gibt zurück

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 von Dialog.getVersion

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

Gibt zurück

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

geerbt von Dialog.onDialogEvent

Wenn sie in einer abgeleiteten Klasse überschrieben wird, wird der Benutzer erneut zur Eingabe aufgefordert.

function repromptDialog(_context: TurnContext, _instance: DialogInstance): Promise<void>

Parameter

Gibt zurück

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

• DialogContext.repromptDialog
• Prompt

geerbt von Dialog.repromptDialog