SkillDialog class

Paket:

botbuilder-dialogs

Ein spezielles Dialogfeld, das Remoteanrufe an eine Fähigkeit umschließen kann.

Extends

Dialog<Partial<BeginSkillDialogOptions>>

Hinweise

Der Optionsparameter in beginDialog muss eine BeginSkillDialogOptions-Instanz mit den anfänglichen Parametern für das Dialogfeld sein.

Konstruktoren

SkillDialog(SkillDialogOptions, string)

Ein Beispieldialogfeld, das Remoteanrufe an eine Fähigkeit umschließen kann.

Eigenschaften

id	Eindeutige ID des Dialogfelds. Legt die eindeutige ID des Dialogfelds fest.
telemetryClient	Ruft den Telemetrieclient für dieses Dialogfeld ab. Legt den Telemetrieclient für dieses Dialogfeld fest.

Geerbte Eigenschaften

EndOfTurn

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

Methoden

beginDialog(DialogContext, BeginSkillDialogOptions)	Wird aufgerufen, wenn das Fähigkeitsdialogfeld gestartet und auf den Dialogstapel verschoben wird.
continueDialog(DialogContext)	Wird aufgerufen, wenn das Qualifikationsdialogfeld fortgesetztenwird, wobei es sich um das aktive Dialogfeld handelt und der Benutzer mit einem neuen Aktivitäts-antwortet.
endDialog(TurnContext, DialogInstance, DialogReason)	Wird aufgerufen, wenn das Qualifikationsdialogfeld beendet wird.
repromptDialog(TurnContext, DialogInstance)	Wird aufgerufen, wenn das Qualifikationsdialogfeld den Benutzer erneut zur Eingabe auffordert.
resumeDialog(DialogContext, DialogReason, any)	Wird aufgerufen, wenn ein Dialogfeld mit untergeordneten Fähigkeiten 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.
getConverter(string)
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

SkillDialog(SkillDialogOptions, string)

Ein Beispieldialogfeld, das Remoteanrufe an eine Fähigkeit umschließen kann.

new SkillDialog(dialogOptions: SkillDialogOptions, dialogId?: string)

Parameter

dialogOptions

SkillDialogOptions

Die Optionen zum Ausführen des Fähigkeitsdialogfelds.

dialogId

string

Die ID des Dialogfelds.

Hinweise

Der Optionsparameter in beginDialog() muss ein SkillDialogArgs-Objekt mit den anfänglichen Parametern für das Dialogfeld sein.

Details zur Eigenschaft

id

Eindeutige ID des Dialogfelds. Legt die eindeutige ID des Dialogfelds fest.

string id

Eigenschaftswert

string

Die ID für das Dialogfeld.

Hinweise

Dies wird automatisch generiert, wenn nicht angegeben.

telemetryClient

Ruft den Telemetrieclient für dieses Dialogfeld ab. Legt den Telemetrieclient für dieses Dialogfeld fest.

BotTelemetryClient telemetryClient

Eigenschaftswert

BotTelemetryClient

Der BotTelemetryClient für die Protokollierung verwendet werden.

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.

vonDialog.EndOfTurn geerbt

Details zur Methode

beginDialog(DialogContext, BeginSkillDialogOptions)

Wird aufgerufen, wenn das Fähigkeitsdialogfeld gestartet und auf den Dialogstapel verschoben wird.

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

Parameter

dc

DialogContext

Die DialogContext- für die aktuelle Unterhaltungswende.

options

BeginSkillDialogOptions

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

Gibt zurück

Promise<DialogTurnResult>

Eine Zusage, die den asynchronen Vorgang darstellt.

Hinweise

Wenn die Aufgabe erfolgreich ist, gibt das Ergebnis an, ob das Dialogfeld noch aktiv ist, nachdem die Drehung vom Dialogfeld verarbeitet wurde.

continueDialog(DialogContext)

Wird aufgerufen, wenn das Qualifikationsdialogfeld fortgesetztenwird, wobei es sich um das aktive Dialogfeld handelt und der Benutzer mit einem neuen Aktivitäts-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.

Hinweise

Wenn die Aufgabe erfolgreich ist, gibt das Ergebnis an, ob das Dialogfeld noch aktiv ist, nachdem die Drehung vom Dialogfeld verarbeitet wurde. Das Ergebnis kann auch einen Rückgabewert enthalten.

endDialog(TurnContext, DialogInstance, DialogReason)

Wird aufgerufen, wenn das Qualifikationsdialogfeld beendet wird.

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

Parameter

context

TurnContext

Das TurnContext--Objekt für diese Drehung.

instance

DialogInstance

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

reason

DialogReason

(xref:botbuilder-dialogs. DialogReason) warum das Dialogfeld beendet wurde.

Gibt zurück

Promise<void>

Eine Zusage, die den asynchronen Vorgang darstellt.

repromptDialog(TurnContext, DialogInstance)

Wird aufgerufen, wenn das Qualifikationsdialogfeld den Benutzer erneut zur Eingabe auffordert.

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

Parameter

context

TurnContext

Das TurnContext--Objekt für diese Drehung.

instance

DialogInstance

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 Dialogfeld mit untergeordneten Fähigkeiten 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

Die DialogContext- für die aktuelle Unterhaltung.

_reason

DialogReason

(xref:botbuilder-dialogs. DialogReason) 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 vonKonfigurierbar.configure

getConverter(string)

function getConverter(_property: string): Converter | ConverterFactory

Parameter

_property

string

Der Schlüssel der Konfiguration der bedingten Auswahl.

Gibt zurück

Converter | ConverterFactory

Der Konverter für die Selektorkonfiguration.

Geerbt vonKonfigurierbar.getConverter

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