CancelAllDialogsBase class

Paket:

botbuilder-dialogs-adaptive

Basisklasse für CancelAllDialogs-API.

Extends

Dialog<O>

Konstruktoren

CancelAllDialogsBase()	Initialisiert eine neue Instanz der CancelAllDialogsBase- Klasse.
CancelAllDialogsBase(string, string, boolean)	Initialisiert eine neue Instanz der CancelAllDialogsBase- Klasse.

Eigenschaften

activityProcessed	Ein Wert, der angibt, ob das neue Dialogfeld die Aktivität verarbeiten soll.
disabled	Ein optionaler Ausdruck, der bei "true" diese Aktion deaktiviert.
eventName	Ausdruck für den Ereignisnamen.
eventValue	Ausdruck für Den Ereigniswert.

Geerbte Eigenschaften

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

Methoden

beginDialog(DialogContext, O)	Wird aufgerufen, wenn das Dialogfeld gestartet und in den Dialogstapel verschoben wird.
getConverter(Object)

Geerbte Methoden

configure(Record<string, unknown>)	Fluent-Methode zum Konfigurieren des Objekts.
continueDialog(DialogContext)	Wenn sie in einer abgeleiteten Klasse überschrieben wird, wird das Dialogfeld fortgesetzt.
endDialog(TurnContext, DialogInstance, DialogReason)	Wenn sie in einer abgeleiteten Klasse überschrieben wird, wird das Dialogfeld vor dem Beenden bereinigt.
getVersion()	Eine codierte Zeichenfolge zur Unterstützung der Erkennung von Bot-Änderungen bei der erneuten Bereitstellung.
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.
repromptDialog(TurnContext, DialogInstance)	Wenn sie in einer abgeleiteten Klasse überschrieben wird, wird der Benutzer erneut zur Eingabe aufgefordert.
resumeDialog(DialogContext, DialogReason, any)	Wenn sie in einer abgeleiteten Klasse überschrieben wird, wird das Dialogfeld nach Abschluss des Dialogfelds auf dem Stapel fortgesetzt.

Details zum Konstruktor

CancelAllDialogsBase()

Initialisiert eine neue Instanz der CancelAllDialogsBase- Klasse.

new CancelAllDialogsBase()

CancelAllDialogsBase(string, string, boolean)

Initialisiert eine neue Instanz der CancelAllDialogsBase- Klasse.

new CancelAllDialogsBase(eventName: string, eventValue?: string, isCancelAll?: boolean)

Parameter

eventName

string

Ausdruck für den Ereignisnamen.

eventValue

string

Wahlfrei. Ausdruck für Den Ereigniswert.

isCancelAll

boolean

Auf true festlegen, um alle Dialogfelder abzubrechen; andernfalls false.

Details zur Eigenschaft

activityProcessed

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

activityProcessed: BoolExpression

Eigenschaftswert

BoolExpression

disabled

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

disabled: BoolExpression

Eigenschaftswert

BoolExpression

eventName

Ausdruck für den Ereignisnamen.

eventName: StringExpression

Eigenschaftswert

StringExpression

eventValue

Ausdruck für Den Ereigniswert.

eventValue: ValueExpression

Eigenschaftswert

ValueExpression

Geerbte Eigenschaftsdetails

EndOfTurn

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

static EndOfTurn: DialogTurnResult

Eigenschaftswert

DialogTurnResult

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

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 das Dialogfeld gestartet und in den Dialogstapel verschoben wird.

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

Parameter

dc

DialogContext

Die DialogContext- für die aktuelle Unterhaltungswende.

_options

O

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

Gibt zurück

Promise<DialogTurnResult>

Eine Promise, die den asynchronen Vorgang darstellt.

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.

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>

Anzuwendende Konfigurationseinstellungen.

Gibt zurück

this

Die konfigurierbaren nach Abschluss des Vorgangs.

Geerbt von Konfigurierbar.configure

continueDialog(DialogContext)

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

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

Parameter

dc

DialogContext

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

• DialogContext.continueDialog

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

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

von Dialog.endDialog geerbt

getVersion()

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

function getVersion(): string

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

dc

DialogContext

Der Dialogkontext für die aktuelle Unterhaltungswende.

e

DialogEvent

Das ausgelöste Ereignis.

Gibt zurück

Promise<boolean>

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

geerbt von Dialog.onDialogEvent

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

• DialogContext.repromptDialog
• Aufforderung

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

dc

DialogContext

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

• DialogContext.endDialog-

Geerbt von Dialog.resumeDialog