AdaptiveDialog class

Paket:

botbuilder-dialogs-adaptive

Die Unterhaltung im adaptiven Dialogfeld wird mithilfe von Ereignissen und Ereignissen modelliert, um sich dynamisch an den geänderten Unterhaltungsfluss anzupassen.

Extends

DialogContainer<O>

Konstruktoren

AdaptiveDialog(string)

Erstellt eine neue AdaptiveDialog Instanz.

Eigenschaften

$kind
autoEndDialog	Gibt an, ob das Dialogfeld beendet werden soll, wenn keine Aktionen ausgeführt werden sollen.
conditionTracker
defaultResultProperty	Die Eigenschaft, die als Ergebnis zurückgegeben werden soll, wenn das Dialogfeld endet, wenn keine weiteren Aktionen vorhanden sind und AutoEndDialog = true.
generator	Wahlfrei. Außerkraftsetzung des Sprachgenerators.
recognizer	Wahlfrei. Erkennung, die zum Analysieren von Äußerungen von Nachrichten verwendet wird.
schema	Legt das JSON-Schema für das Dialogfeld fest. Ruft das JSON-Schema für das Dialogfeld ab.
selector	Wahlfrei. Die Auswahl zum Auswählen der auszuführenden Möglichen Ereignisse.
triggers	Lösen Sie Handler aus, um auf Bedingungen zu reagieren, die den Ausführungsplan ändern.

Geerbte Eigenschaften

dialogs	Das Dialogfeld "Container" wird festgelegt.
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.
continueDialog(DialogContext)	Wird aufgerufen, wenn das Dialogfeld fortgesetzt, wobei es sich um das aktive Dialogfeld handelt und der Benutzer mit einer neuen Aktivität antwortet.
createChildContext(DialogContext)	Erstellt ein untergeordnetes DialogContext- für den angegebenen Kontext.
endDialog(TurnContext, DialogInstance, DialogReason)	Wird aufgerufen, wenn das Dialogfeld beendet wird.
getConverter(Object)
getDependencies()	Ruft Dialog aufgezählten Abhängigkeiten ab.
repromptDialog(DialogContext | TurnContext, DialogInstance)	Erprompt den Benutzer erneut.
resumeDialog(DialogContext, DialogReason, any)	Wird aufgerufen, wenn ein untergeordnetes Dialogfeld seine Drehung abgeschlossen hat, und gibt das Steuerelement zu diesem Dialogfeld zurück.

Geerbte Methoden

configure(Record<string, unknown>)	Fluent-Methode zum Konfigurieren des Objekts.
findDialog(string)	Sucht ein untergeordnetes Dialogfeld, das zuvor dem Container hinzugefügt wurde.
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.

Details zum Konstruktor

AdaptiveDialog(string)

Erstellt eine neue AdaptiveDialog Instanz.

new AdaptiveDialog(dialogId?: string)

Parameter

dialogId

string

(Optional) eindeutige ID der Komponente innerhalb des übergeordneten Dialogfelds.

Details zur Eigenschaft

$kind

static $kind: string

Eigenschaftswert

string

autoEndDialog

Gibt an, ob das Dialogfeld beendet werden soll, wenn keine Aktionen ausgeführt werden sollen.

autoEndDialog: BoolExpression

Eigenschaftswert

BoolExpression

Hinweise

Wenn true, wenn keine Auszuführenden Aktionen vorhanden sind, wird das aktuelle Dialogfeld beendet. Wenn "false" ausgeführt werden soll, beendet das aktuelle Dialogfeld einfach die Drehung und bleibt aktiv. Der Standardwert ist der Wert "true".

conditionTracker

static conditionTracker: string

Eigenschaftswert

string

defaultResultProperty

Die Eigenschaft, die als Ergebnis zurückgegeben werden soll, wenn das Dialogfeld endet, wenn keine weiteren Aktionen vorhanden sind und AutoEndDialog = true.

defaultResultProperty: string

Eigenschaftswert

string

Hinweise

Der Standardwert ist ein Wert von dialog.result.

generator

Wahlfrei. Außerkraftsetzung des Sprachgenerators.

generator?: LanguageGenerator

Eigenschaftswert

LanguageGenerator

recognizer

Wahlfrei. Erkennung, die zum Analysieren von Äußerungen von Nachrichten verwendet wird.

recognizer?: Recognizer

Eigenschaftswert

Recognizer

schema

Legt das JSON-Schema für das Dialogfeld fest. Ruft das JSON-Schema für das Dialogfeld ab.

object schema

Eigenschaftswert

object

Das Dialogfeldschema.

selector

Wahlfrei. Die Auswahl zum Auswählen der auszuführenden Möglichen Ereignisse.

selector: TriggerSelector

Eigenschaftswert

TriggerSelector

triggers

Lösen Sie Handler aus, um auf Bedingungen zu reagieren, die den Ausführungsplan ändern.

triggers: OnCondition[]

Eigenschaftswert

OnCondition[]

Geerbte Eigenschaftsdetails

dialogs

Das Dialogfeld "Container" wird festgelegt.

dialogs: DialogSet

Eigenschaftswert

DialogSet

von DialogContainer.dialogs geerbt

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

Optional, erste Informationen, die an das Dialogfeld übergeben werden sollen.

Gibt zurück

Promise<DialogTurnResult>

Eine Zusage, die den asynchronen Vorgang darstellt.

continueDialog(DialogContext)

Wird aufgerufen, wenn das Dialogfeld fortgesetzt, wobei es sich um das aktive Dialogfeld handelt und der Benutzer mit einer neuen Aktivität antwortet.

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

Parameter

dc

DialogContext

Die DialogContext- für die aktuelle Unterhaltungswende.

Gibt zurück

Promise<DialogTurnResult>

Eine Zusage, die den asynchronen Vorgang darstellt.

createChildContext(DialogContext)

Erstellt ein untergeordnetes DialogContext- für den angegebenen Kontext.

function createChildContext(dc: DialogContext): DialogContext

Parameter

dc

DialogContext

Die DialogContext- für die aktuelle Unterhaltungswende.

Gibt zurück

DialogContext

Das untergeordnete DialogContext oder NULL, wenn für den angegebenen Kontext keine AdaptiveDialogState.actions gefunden werden.

endDialog(TurnContext, DialogInstance, DialogReason)

Wird aufgerufen, wenn das Dialogfeld beendet wird.

function endDialog(turnContext: TurnContext, instance: DialogInstance, reason: DialogReason): Promise<void>

Parameter

turnContext

TurnContext

Das Kontextobjekt für diese Drehung.

instance

DialogInstance

Statusinformationen, die der Instanz dieses Dialogfelds im Dialogstapel zugeordnet sind.

reason

DialogReason

Grund, warum das Dialogfeld beendet wurde.

Gibt zurück

Promise<void>

Eine Zusage, 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.

getDependencies()

Ruft Dialog aufgezählten Abhängigkeiten ab.

function getDependencies(): Dialog[]

Gibt zurück

Dialog[]

(xref:botbuilder-dialogs. Die aufgezählten Abhängigkeiten des Dialogfelds.

repromptDialog(DialogContext | TurnContext, DialogInstance)

Erprompt den Benutzer erneut.

function repromptDialog(context: DialogContext | TurnContext, instance: DialogInstance): Promise<void>

Parameter

context

DialogContext | TurnContext

Das Kontextobjekt für die Drehung.

instance

DialogInstance

Aktuelle Statusinformationen für dieses Dialogfeld.

Gibt zurück

Promise<void>

Eine Zusage, die den asynchronen Vorgang darstellt.

resumeDialog(DialogContext, DialogReason, any)

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

function resumeDialog(dc: DialogContext, _reason?: DialogReason, _result?: any): Promise<DialogTurnResult>

Parameter

dc

DialogContext

Der Dialogfeldkontext für die aktuelle Drehung der Unterhaltung.

_reason

DialogReason

Grund, warum das Dialogfeld fortgesetzt wurde.

_result

any

Optionaler Wert, der aus dem aufgerufenen Dialogfeld zurückgegeben wurde. Der Typ des zurückgegebenen Werts hängt vom untergeordneten Dialogfeld ab.

Gibt zurück

Promise<DialogTurnResult>

Eine Zusage, die den asynchronen Vorgang darstellt.

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

findDialog(string)

Sucht ein untergeordnetes Dialogfeld, das zuvor dem Container hinzugefügt wurde.

function findDialog(dialogId: string): Dialog | undefined

Parameter

dialogId

string

ID des zu suchenden Dialogfelds.

Gibt zurück

Dialog | undefined

Das Dialogfeld, falls gefunden; andernfalls NULL.

Geerbt von DialogContainer.findDialog

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 DialogContainer.onDialogEvent