InputDialog class

Initialisiert eine neue Instanz der InputDialog- Klasse.

new InputDialog(property?: string, prompt?: Partial<Activity> | string)

Parameter

Unterbrechungsrichtlinie.

allowInterruptions: BoolExpression

Eigenschaftswert

Ein Wert, der angibt, ob die Eingabe immer den Benutzer auffordern soll, unabhängig davon, ob ein Wert vorhanden ist oder nicht.

alwaysPrompt: BoolExpression

Eigenschaftswert

Der Standardwert für das Eingabedialogfeld, wenn maxTurnCount überschritten wird.

defaultValue?: ValueExpression

Eigenschaftswert

Die Aktivitätsvorlage, die gesendet werden soll, wenn maxTurnCount erreicht wurde und der Standardwert verwendet wird.

defaultValueResponse: TemplateInterface<Partial<Activity>, DialogStateManager>

Eigenschaftswert

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

disabled?: BoolExpression

Eigenschaftswert

Die Aktivitätsvorlage, die an den Benutzer gesendet werden soll, wenn der angegebene Wert ungültig ist oder nicht.

invalidPrompt: TemplateInterface<Partial<Activity>, DialogStateManager>

Eigenschaftswert

Maximale Anzahl von Malen, mit denen der Benutzer nach diesem Wert gefragt wird, bevor das Dialogfeld angezeigt wird.

maxTurnCount?: IntExpression

Eigenschaftswert

static OPTIONS_PROPERTY: string

Eigenschaftswert

Die Aktivität, die an den Benutzer gesendet werden soll.

prompt: TemplateInterface<Partial<Activity>, DialogStateManager>

Eigenschaftswert

Der Wertausdruck, an den die Eingabe gebunden wird.

property: StringExpression

Eigenschaftswert

static TURN_COUNT_PROPERTY: string

Eigenschaftswert

Die Aktivitätsvorlage zum Wiederholen der Eingabeaufforderung.

unrecognizedPrompt: TemplateInterface<Partial<Activity>, DialogStateManager>

Eigenschaftswert

Die Ausdrücke, die ausgeführt werden sollen, um die Eingabe zu überprüfen.

validations: string[]

Eigenschaftswert

Ein Wertausdruck, der zum Initialisieren der Eingabeaufforderung verwendet werden kann.

value: ValueExpression

Eigenschaftswert

static VALUE_PROPERTY: string

Eigenschaftswert

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

static EndOfTurn: DialogTurnResult

Eigenschaftswert

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: string

Eigenschaftswert

geerbt von Dialog.id

telemetryClient: BotTelemetryClient

Eigenschaftswert

Geerbt von Dialog.telemetryClient

Wird aufgerufen, wenn das Dialogfeld gestartet und in den Dialogstapel verschoben wird.

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

Parameter

Gibt zurück

Ein DialogTurnResult-Promise, das den asynchronen Vorgang darstellt.

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

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

Parameter

Gibt zurück

Ein DialogTurnResult-Promise, das den asynchronen Vorgang darstellt.

function getConverter(property: Object): Converter | ConverterFactory

Parameter

Gibt zurück

Der Konverter für die Selektorkonfiguration.

Wird aufgerufen, wenn ein untergeordnetes Dialog seine Drehung beendet, und das Steuerelement wird an dieses Dialogfeld zurückgegeben.

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

Parameter

Gibt zurück

Ein DialogTurnResult-Promise, das den asynchronen Vorgang darstellt.

Fluent-Methode zum Konfigurieren des Objekts.

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

Parameter

Gibt zurück

Die konfigurierbaren nach Abschluss des Vorgangs.

Geerbt von Konfigurierbar.configure

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

Gibt zurück

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

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

function getVersion(): string

Gibt zurück

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

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

Gibt zurück

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

geerbt von Dialog.onDialogEvent

Wenn sie in einer abgeleiteten Klasse überschrieben wird, wird der Benutzer erneut zur Eingabe aufgefordert.

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

Parameter

Gibt zurück

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
• Prompt

geerbt von Dialog.repromptDialog