ChoiceInput class

Paket:

botbuilder-dialogs-adaptive

ChoiceInput – Deklarative Eingabe zum Sammeln von Auswahlmöglichkeiten vom Benutzer.

Extends

InputDialog

Konstruktoren

ChoiceInput(string, Partial<Activity> | string)

Initialisiert eine neue Instanz der InputDialog- Klasse.

Eigenschaften

$kind
choiceOptions	Zusätzliche Optionen, die an die ChoiceFactory übergeben und verwendet werden, um die Art der Auswahl zu optimieren, die für den Benutzer gerendert wird.
choices	Liste der Optionen, die dem Benutzer präsentiert werden sollen.
defaultLocale	Das Standardgebietsschema der Eingabeaufforderungen, das erkannt werden soll.
outputFormat	Steuern sie das Format der Antwort (Wert oder Index der Auswahl).
recognizerOptions	Weitere Optionen, die an die zugrunde liegende recognizeChoices()-Funktion übergeben werden.
style	Stil der "Ja"- und "Nein"-Auswahl, die beim Eingabeaufforderung für den Benutzer gerendert wird.

Geerbte Eigenschaften

allowInterruptions	Unterbrechungsrichtlinie.
alwaysPrompt	Ein Wert, der angibt, ob die Eingabe immer den Benutzer auffordern soll, unabhängig davon, ob ein Wert vorhanden ist oder nicht.
defaultValue	Der Standardwert für das Eingabedialogfeld, wenn maxTurnCount überschritten wird.
defaultValueResponse	Die Aktivitätsvorlage, die gesendet werden soll, wenn maxTurnCount erreicht wurde und der Standardwert verwendet wird.
disabled	Ein optionaler Ausdruck, der bei "true" diese Aktion deaktiviert.
EndOfTurn	Ruft ein Standardmäßiges End-of-Turn-Ergebnis ab.
id
invalidPrompt	Die Aktivitätsvorlage, die an den Benutzer gesendet werden soll, wenn der angegebene Wert ungültig ist oder nicht.
maxTurnCount	Maximale Anzahl von Malen, mit denen der Benutzer nach diesem Wert gefragt wird, bevor das Dialogfeld angezeigt wird.
OPTIONS_PROPERTY
prompt	Die Aktivität, die an den Benutzer gesendet werden soll.
property	Der Wertausdruck, an den die Eingabe gebunden wird.
telemetryClient
TURN_COUNT_PROPERTY
unrecognizedPrompt	Die Aktivitätsvorlage zum Wiederholen der Eingabeaufforderung.
validations	Die Ausdrücke, die ausgeführt werden sollen, um die Eingabe zu überprüfen.
value	Ein Wertausdruck, der zum Initialisieren der Eingabeaufforderung verwendet werden kann.
VALUE_PROPERTY

Methoden

getConverter(Object)

Geerbte Methoden

beginDialog(DialogContext, any)	Wird aufgerufen, wenn das Dialogfeld gestartet und in den Dialogstapel verschoben wird.
configure(Record<string, unknown>)	Fluent-Methode zum Konfigurieren des Objekts.
continueDialog(DialogContext)	Wird aufgerufen, wenn das Dialog-fortgesetzt wird, wobei es sich um das aktive Dialogfeld handelt und der Benutzer mit einer neuen Aktivität antwortet.
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)	Wird aufgerufen, wenn ein untergeordnetes Dialog seine Drehung beendet, und das Steuerelement wird an dieses Dialogfeld zurückgegeben.

Details zum Konstruktor

ChoiceInput(string, Partial<Activity> | string)

Initialisiert eine neue Instanz der InputDialog- Klasse.

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

Parameter

property

string

Wahlfrei. Der Wertausdruck, an den die Eingabe gebunden wird.

prompt

Partial<Activity> | string

Wahlfrei. Die Activity, die an den Benutzer gesendet werden soll, wenn eine Zeichenfolge angegeben wird, instanziiert sie eine ActivityTemplate-.

Details zur Eigenschaft

$kind

static $kind: string

Eigenschaftswert

string

choiceOptions

Zusätzliche Optionen, die an die ChoiceFactory übergeben und verwendet werden, um die Art der Auswahl zu optimieren, die für den Benutzer gerendert wird.

choiceOptions?: ObjectExpression<ChoiceFactoryOptions>

Eigenschaftswert

ObjectExpression<ChoiceFactoryOptions>

choices

Liste der Optionen, die dem Benutzer präsentiert werden sollen.

choices: ObjectExpression<ChoiceSet>

Eigenschaftswert

ObjectExpression<ChoiceSet>

defaultLocale

Das Standardgebietsschema der Eingabeaufforderungen, das erkannt werden soll.

defaultLocale?: StringExpression

Eigenschaftswert

StringExpression

outputFormat

Steuern sie das Format der Antwort (Wert oder Index der Auswahl).

outputFormat: EnumExpression<ChoiceOutputFormat>

Eigenschaftswert

EnumExpression<ChoiceOutputFormat>

recognizerOptions

Weitere Optionen, die an die zugrunde liegende recognizeChoices()-Funktion übergeben werden.

recognizerOptions?: ObjectExpression<FindChoicesOptions>

Eigenschaftswert

ObjectExpression<FindChoicesOptions>

style

Stil der "Ja"- und "Nein"-Auswahl, die beim Eingabeaufforderung für den Benutzer gerendert wird.

style: EnumExpression<ListStyle>

Eigenschaftswert

EnumExpression<ListStyle>

Hinweise

Standardmäßig wird ListStyle.auto.

Geerbte Eigenschaftsdetails

allowInterruptions

Unterbrechungsrichtlinie.

allowInterruptions: BoolExpression

Eigenschaftswert

BoolExpression

VonInputDialog.allowInterruptions- geerbt

alwaysPrompt

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

BoolExpression

vonInputDialog.alwaysPrompt geerbt

defaultValue

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

defaultValue?: ValueExpression

Eigenschaftswert

ValueExpression

vonInputDialog.defaultValue- geerbt

defaultValueResponse

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

defaultValueResponse: TemplateInterface<Partial<Activity>, DialogStateManager>

Eigenschaftswert

TemplateInterface<Partial<Activity>, DialogStateManager>

vonInputDialog.defaultValueResponse

disabled

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

disabled?: BoolExpression

Eigenschaftswert

BoolExpression

VonInputDialog.disabled 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

invalidPrompt

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

TemplateInterface<Partial<Activity>, DialogStateManager>

VonInputDialog.invalidPrompt geerbt

maxTurnCount

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

maxTurnCount?: IntExpression

Eigenschaftswert

IntExpression

vonInputDialog.maxTurnCount geerbt

OPTIONS_PROPERTY

static OPTIONS_PROPERTY: string

Eigenschaftswert

string

geerbt vonInputDialog.OPTIONS_PROPERTY

prompt

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

prompt: TemplateInterface<Partial<Activity>, DialogStateManager>

Eigenschaftswert

TemplateInterface<Partial<Activity>, DialogStateManager>

vonInputDialog.prompt geerbt

property

Der Wertausdruck, an den die Eingabe gebunden wird.

property: StringExpression

Eigenschaftswert

StringExpression

VonInputDialog.property geerbt

telemetryClient

telemetryClient: BotTelemetryClient

Eigenschaftswert

BotTelemetryClient

Geerbt von Dialog.telemetryClient

TURN_COUNT_PROPERTY

static TURN_COUNT_PROPERTY: string

Eigenschaftswert

string

geerbt vonInputDialog.TURN_COUNT_PROPERTY

unrecognizedPrompt

Die Aktivitätsvorlage zum Wiederholen der Eingabeaufforderung.

unrecognizedPrompt: TemplateInterface<Partial<Activity>, DialogStateManager>

Eigenschaftswert

TemplateInterface<Partial<Activity>, DialogStateManager>

vonInputDialog.unrecognizedPrompt-

validations

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

validations: string[]

Eigenschaftswert

string[]

VonInputDialog.validations geerbt

value

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

value: ValueExpression

Eigenschaftswert

ValueExpression

VonInputDialog.value geerbt

VALUE_PROPERTY

static VALUE_PROPERTY: string

Eigenschaftswert

string

geerbt vonInputDialog.VALUE_PROPERTY

Details zur Methode

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

beginDialog(DialogContext, any)

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

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

Parameter

dc

DialogContext

Die DialogContext- für die aktuelle Unterhaltungswende.

options

any

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

Gibt zurück

Promise<DialogTurnResult>

Ein DialogTurnResult-Promise, das den asynchronen Vorgang darstellt.

vonInputDialog.beginDialog

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)

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

dc

DialogContext

Die DialogContext- für die aktuelle Unterhaltungswende.

Gibt zurück

Promise<DialogTurnResult>

Ein DialogTurnResult-Promise, das den asynchronen Vorgang darstellt.

VonInputDialog.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)

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

dc

DialogContext

Die DialogContext- für die aktuelle Unterhaltungswende.

_reason

DialogReason

(xref:botbuilder-dialogs. DialogReason), Grund, warum das Dialogfeld fortgesetzt wurde.

_result

any

Wahlfrei. Der wert, der vom aufgerufenen Dialog zurückgegeben wurde. Der Typ des zurückgegebenen Werts hängt vom untergeordneten Dialogfeld ab.

Gibt zurück

Promise<DialogTurnResult>

Ein DialogTurnResult-Promise, das den asynchronen Vorgang darstellt.

vonInputDialog.resumeDialog