SwitchCondition class

Paket:

botbuilder-dialogs-adaptive

Bedingter Branch mit mehreren Fällen.

Extends

Dialog<O>

Konstruktoren

SwitchCondition()	Initialisiert eine neue Instanz der SwitchCondition-Klasse
SwitchCondition(string, Dialog[], Case[])	Initialisiert eine neue Instanz der SwitchCondition-Klasse

Eigenschaften

$kind
cases	Fällen.
condition	Bedingungsausdruck für den Arbeitsspeicher.
default	Standard-Groß-/Kleinschreibung.
disabled	Ein optionaler Ausdruck, der diese Aktion deaktiviert, wenn true ist.

Geerbte Eigenschaften

EndOfTurn	Ruft ein Standardergebnis ab.
id
telemetryClient

Methoden

beginDialog(DialogContext, O)	Startet einen neuen Dialog und pusht ihn auf den Dialogstapel.
getConverter(Object)
getDependencies()	Ruft die untergeordneten Dialogabhängigkeiten ab, damit sie dem Dialogsatz containern können.

Geerbte Methoden

configure(Record<string, unknown>)	Fluent-Methode zum Konfigurieren des Objekts.
continueDialog(DialogContext)	Wenn sie in einer abgeleiteten Klasse überschrieben wird, wird der Dialog fortgesetzt.
endDialog(TurnContext, DialogInstance, DialogReason)	Führt beim Überschreiben in einer abgeleiteten Klasse eine Bereinigen des Dialogfelds aus, bevor es endet.
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 mit ausgelöst wurde, entweder DialogContext.emitEvent()durch den aktuellen Dialog oder einen Dialog, den 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 der Dialog fortgesetzt, nachdem der Darüberdialog auf dem Stapel abgeschlossen wurde.

Details zum Konstruktor

SwitchCondition()

Initialisiert eine neue Instanz der SwitchCondition-Klasse

new SwitchCondition()

SwitchCondition(string, Dialog[], Case[])

Initialisiert eine neue Instanz der SwitchCondition-Klasse

new SwitchCondition(condition: string, defaultDialogs: Dialog[], cases: Case[])

Parameter

condition

string

Bedingungsausdruck für den Arbeitsspeicher.

defaultDialogs

Dialog[]

Standard-Dialogfeldarray.

cases

Case[]

Fällen.

Details zur Eigenschaft

$kind

static $kind: string

Eigenschaftswert

string

cases

Fällen.

cases: Case[]

Eigenschaftswert

Case[]

condition

Bedingungsausdruck für den Arbeitsspeicher.

condition: Expression

Eigenschaftswert

Expression

default

Standard-Groß-/Kleinschreibung.

default: Dialog[]

Eigenschaftswert

Dialog[]

disabled

Ein optionaler Ausdruck, der diese Aktion deaktiviert, wenn true ist.

disabled?: BoolExpression

Eigenschaftswert

BoolExpression

Geerbte Eigenschaftsdetails

EndOfTurn

Ruft ein Standardergebnis ab.

static EndOfTurn: DialogTurnResult

Eigenschaftswert

DialogTurnResult

Hinweise

Dieses Ergebnis gibt an, dass ein Dialog (oder ein logischer Schritt in einem Dialog) die Verarbeitung für den aktuellen Turn abgeschlossen hat, weiterhin 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)

Startet einen neuen Dialog und pusht ihn auf den Dialogstapel.

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

Parameter

dc

DialogContext

Der DialogContext für den aktuellen Gesprächsverlauf.

_options

O

Optional. Erste 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 des bedingten Selektors.

Gibt zurück

Converter | ConverterFactory

Der Konverter für die Selektorkonfiguration.

getDependencies()

Ruft die untergeordneten Dialogabhängigkeiten ab, damit sie dem Dialogsatz containern können.

function getDependencies(): Dialog[]

Gibt zurück

Dialog[]

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)

Wenn sie in einer abgeleiteten Klasse überschrieben wird, 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 zum Ergebnis des Dialogwechsels aufgelöst wird.

Hinweise

Abgeleitete Dialoge, die Unterhaltungen mit mehreren Wendungen 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 das Dialogfeld 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 Bereinigen des Dialogfelds aus, bevor es endet.

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 endet.

Gibt zurück

Promise<void>

Hinweise

Abgeleitete Dialogfelder, die vor dem Ende protokollierungs- oder bereinigungsvorgängen müssen, sollten diese Methode überschreiben. Standardmäßig hat diese Methode keine Auswirkungen.

DialogContext ruft diese Methode auf, wenn das aktuelle Dialogfeld endet.

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 vollständig deaktiviert.

Geerbt von Dialog.getVersion

onDialogEvent(DialogContext, DialogEvent)

Wird aufgerufen, wenn ein Ereignis mit ausgelöst wurde, entweder DialogContext.emitEvent()durch den aktuellen Dialog oder einen Dialog, den das aktuelle Dialogfeld gestartet hat.

function onDialogEvent(dc: DialogContext, e: DialogEvent): Promise<boolean>

Parameter

dc

DialogContext

Der Dialogkontext für den aktuellen Gesprächsverlauf.

e

DialogEvent

Das ausgelöste Ereignis.

Gibt zurück

Promise<boolean>

True, wenn das Ereignis vom aktuellen Dialogfeld behandelt wird und das Brodeln 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 den Turn.

_instance

DialogInstance

Aktuelle Statusinformationen für dieses Dialogfeld.

Gibt zurück

Promise<void>

Hinweise

Abgeleitete Dialogfelder, 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)

Wenn sie in einer abgeleiteten Klasse überschrieben wird, wird der Dialog fortgesetzt, nachdem der Darüberdialog auf dem 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 zum Ergebnis des Dialogwechsels aufgelöst wird.

Hinweise

Abgeleitete Dialoge, die Unterhaltungen mit mehreren Wendungen 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 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 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