BaseInvokeDialog class

Paket:

botbuilder-dialogs-adaptive

Aktion, die einen weiteren Dialog aufruft.

Extends

Dialog<O>

Konstruktoren

BaseInvokeDialog(string, O)

Initialisiert eine neue Instanz der BaseInvokeDialog-Klasse .

Eigenschaften

activityProcessed	Ein Wert, der angibt, ob der neue Dialog die Aktivität verarbeiten soll.
dialog	Das aufzurufende Dialogfeld.
options	Konfigurierbare Optionen für das Dialogfeld.

Geerbte Eigenschaften

EndOfTurn	Ruft ein Standardergebnis ab.
id
telemetryClient

Methoden

beginDialog(DialogContext, O)	Wird aufgerufen, wenn der Dialog gestartet und in den Dialogstapel gepusht wird.
getConverter(Object)
getDependencies()	Ruft die untergeordneten Dialogabhängigkeiten ab, damit sie dem Containerdialogsatz hinzugefügt werden können.

Geerbte Methoden

configure(Record<string, unknown>)	Fluent-Methode zum Konfigurieren des Objekts.
continueDialog(DialogContext)	Beim Überschreiben in einer abgeleiteten Klasse wird der Dialog fortgesetzt.
endDialog(TurnContext, DialogInstance, DialogReason)	Führt beim Überschreiben in einer abgeleiteten Klasse eine Bereinigung für den Dialog aus, bevor es beendet wird.
getVersion()	Eine codierte Zeichenfolge, die bei der Erkennung von Botänderungen bei der erneuten Bereitstellung verwendet wird.
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.
repromptDialog(TurnContext, DialogInstance)	Beim Überschreiben in einer abgeleiteten Klasse wird der Benutzer erneut für die Eingabe bereitgestellt.
resumeDialog(DialogContext, DialogReason, any)	Setzt beim Überschreiben in einer abgeleiteten Klasse den Dialog fort, nachdem der darüber stehende Dialog im Stapel abgeschlossen wurde.

Details zum Konstruktor

BaseInvokeDialog(string, O)

Initialisiert eine neue Instanz der BaseInvokeDialog-Klasse .

new BaseInvokeDialog(dialogIdToCall?: string, bindingOptions?: O)

Parameter

dialogIdToCall

string

Die Dialog-ID.

bindingOptions

O

(optional) Bindungsoptionen.

Details zur Eigenschaft

activityProcessed

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

activityProcessed: BoolExpression

Eigenschaftswert

BoolExpression

dialog

Das aufzurufende Dialogfeld.

dialog: DialogExpression

Eigenschaftswert

DialogExpression

options

Konfigurierbare Optionen für das Dialogfeld.

options: ObjectExpression<object>

Eigenschaftswert

ObjectExpression<object>

Geerbte Eigenschaftsdetails

EndOfTurn

Ruft ein Standardergebnis ab.

static EndOfTurn: DialogTurnResult

Eigenschaftswert

DialogTurnResult

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

id

id: string

Eigenschaftswert

string

Geerbt von Dialog.id

telemetryClient

telemetryClient: BotTelemetryClient

Eigenschaftswert

BotTelemetryClient

Geerbt von Dialog.telemetryClient

Details zur Methode

beginDialog(DialogContext, O)

Wird aufgerufen, wenn der Dialog gestartet und in den Dialogstapel gepusht wird.

function beginDialog(_dc: DialogContext, _options?: O): Promise<DialogTurnResult<any>>

Parameter

_dc

DialogContext

Der DialogContext für den aktuellen Unterhaltungswechsel.

_options

O

Optional. Anfängliche Informationen, die an das Dialogfeld übergeben werden sollen.

Gibt zurück

Promise<DialogTurnResult<any>>

Hinweise

Die Methode wurde nicht implementiert.

getConverter(Object)

function getConverter(property: Object): Converter | ConverterFactory

Parameter

property

Object

Der Schlüssel der Konfiguration der bedingten Auswahl.

Gibt zurück

Converter | ConverterFactory

Der Konverter für die Selektorkonfiguration.

getDependencies()

Ruft die untergeordneten Dialogabhängigkeiten ab, damit sie dem Containerdialogsatz hinzugefügt werden können.

function getDependencies(): Dialog<__type>[]

Gibt zurück

Dialog<__type>[]

Die untergeordneten Dialogabhängigkeiten .

Details zur geerbten Methode

configure(Record<string, unknown>)

Fluent-Methode zum Konfigurieren des Objekts.

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

Parameter

config

Record<string, unknown>

Zu übernehmende Konfigurationseinstellungen.

Gibt zurück

this

Die Konfigurierbare nach Abschluss des Vorgangs.

Geerbt von Konfigurierbar.configure

continueDialog(DialogContext)

Beim Überschreiben in einer abgeleiteten Klasse wird der Dialog fortgesetzt.

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

Parameter

dc

DialogContext

Der Kontext für den aktuellen Dialogwechsel.

Gibt zurück

Promise<DialogTurnResult>

Eine Zusage, die in das Ergebnis des Dialogwechsels aufgelöst wird.

Hinweise

Abgeleitete Dialoge, die Unterhaltungen mit mehreren Durchläufen unterstützen, sollten diese Methode außer Kraft setzen. Standardmäßig signalisiert diese Methode, dass der Dialog abgeschlossen ist, und gibt zurück.

DialogContext ruft diese Methode auf, wenn der Dialog fortgesetzt wird.

Um dem Dialogkontext zu signalisieren, dass dieser Dialog abgeschlossen wurde, warten Sie auf DialogContext.endDialog , bevor Sie diese Methode beenden.

Weitere Informationen

• DialogContext.continueDialog

Geerbt von Dialog.continueDialog

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

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

Geerbt von Dialog.endDialog

getVersion()

Eine codierte Zeichenfolge, die bei der Erkennung von Botänderungen bei der erneuten Bereitstellung verwendet wird.

function getVersion(): string

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

dc

DialogContext

Der Dialogkontext für den aktuellen Unterhaltungswechsel.

e

DialogEvent

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

repromptDialog(TurnContext, DialogInstance)

Beim Überschreiben in einer abgeleiteten Klasse wird der Benutzer erneut für die Eingabe bereitgestellt.

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

Parameter

_context

TurnContext

Das Kontextobjekt für den Turn.

_instance

DialogInstance

Aktuelle Statusinformationen für dieses Dialogfeld.

Gibt zurück

Promise<void>

Hinweise

Abgeleitete Dialoge, die Validierungs- und Eingabeaufforderungslogik unterstützen, sollten diese Methode überschreiben. Standardmäßig hat diese Methode keine Auswirkungen.

DialogContext ruft diese Methode auf, wenn der aktuelle Dialog eingaben vom Benutzer erneut anfordern soll. Diese Methode wird für Eingabeaufforderungsdialoge implementiert.

Weitere Informationen

• DialogContext.repromptDialog
• Eingabeaufforderung

Geerbt von Dialog.repromptDialog

resumeDialog(DialogContext, DialogReason, any)

Setzt beim Überschreiben in einer abgeleiteten Klasse den Dialog fort, nachdem der darüber stehende Dialog im Stapel abgeschlossen wurde.

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

Parameter

dc

DialogContext

Der Kontext für den aktuellen Dialogwechsel.

reason

DialogReason

Der Grund, warum das Dialogfeld fortgesetzt wird. Dies ist in der Regel DialogReason.endCalled.

result

any

Optional. Der Rückgabewert, falls vorhanden, aus dem beendeten Dialogfeld.

Gibt zurück

Promise<DialogTurnResult>

Eine Zusage, die in das Ergebnis des Dialogwechsels aufgelöst wird.

Hinweise

Abgeleitete Dialoge, die Unterhaltungen mit mehreren Durchläufen unterstützen, sollten diese Methode außer Kraft setzen. Standardmäßig signalisiert diese Methode, dass der Dialog abgeschlossen ist, und gibt zurück.

DialogContext ruft diese Methode auf, wenn der Dialog 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 den untergeordneten Dialog gestartet hat. Um dem Dialogkontext zu signalisieren, dass dieser Dialog abgeschlossen wurde, warten Sie auf DialogContext.endDialog , bevor Sie diese Methode beenden.

Weitere Informationen

• DialogContext.endDialog

Geerbt von Dialog.resumeDialog