IPromptTextOptions interface

Paket:

botbuilder

Optionen, die an Prompts.text() oder in einem session.beginDialog() Aufruf einer benutzerdefinierten Eingabeaufforderung basierend auf der PromptText Klasse übergeben werden.

Extends

IPromptOptions

Eigenschaften

attachmentLayout	Hinweis, wie Clients mehrere Anlagen layouten sollen. Der Standardwert ist "list".
attachments	Für eingehende Nachrichten enthält Anlagen wie Bilder, die vom Benutzer gesendet werden. Für ausgehende Nachrichten enthält Objekte wie Karten oder Bilder, die an den Benutzer gesendet werden sollen.
entities	Strukturierte Objekte, die an den Bot oder benutzer übergeben werden.
inputHint	Hinweis für Clients, die sie darüber informieren, ob der Bot weitere Eingaben erwartet oder nicht. Die integrierten Eingabeaufforderungen füllen diesen Wert automatisch für ausgehende Nachrichten auf.
libraryNamespace	(Optional) Namespace, der für lokalisierungs- und andere Zwecke verwendet werden soll. Dies ist standardmäßig der Namespace der Aufrufer.
listStyle	(Optional) Typ der Liste, die für "PromptType.choice" gerendert werden soll. Standardwert ist ListStyle.auto.
localizationNamespace	veraltet stattdessen libraryNamespace- verwenden.
maxLength	(Optional) Maximale Länge, die erkannt werden kann.
maxRetries	(Optional) maximale Anzahl von Malen, um den Benutzer erneut aufzufordern. Standardmäßig wird der Benutzer auf unbestimmte Zeit erneut aufgefordert.
minLength	(Optional) Mindestlänge, die erkannt werden kann.
prompt	(Optional) Anfängliche Eingabeaufforderung, um den Benutzer zu senden. Dies wird in der Regel von der funktion Prompts.xxx() aufgefüllt.
promptAfterAction	(Optional) Flag, das zum Steuern der erneuten Eingabeaufforderung eines Benutzers verwendet wird, nachdem ein Dialogfeld durch eine Aktion gestartet wurde. Der Standardwert ist true.
refDate	(Optional) Bezugsdatum beim Erkennen von Uhrzeiten. Datum, das in Teilstrichen mit Date.getTime() ausgedrückt wird.
retryPrompt	(Optional) Wiederholen Sie die Aufforderung zum Senden, wenn die Benutzerantwort nicht verstanden wird. Standardmäßig wird nur eine erneute Eingabeaufforderung mit einer anpassbaren Systemaufforderung angezeigt.
retrySpeak	(Optional) SSML zum Senden mit dem retryPrompt. Wenn der RetryPrompt vom Typ IMessage oder IIsMessageist, wird dieser Wert ignoriert. Wenn dieser Wert ein Array ist, wird eine Antwort zufällig ausgewählt.
speak	(Optional) SSML zum Senden mit dem ursprünglichen prompt. Wenn die Eingabeaufforderung vom Typ IMessage oder IIsMessageist, wird dieser Wert ignoriert. Wenn dieser Wert ein Array ist, wird eine Antwort zufällig ausgewählt.
textFormat	Format von Textfeldern. Der Standardwert ist "markdown".

Details zur Eigenschaft

attachmentLayout

Hinweis, wie Clients mehrere Anlagen layouten sollen. Der Standardwert ist "list".

attachmentLayout?: string

Eigenschaftswert

string

attachments

Für eingehende Nachrichten enthält Anlagen wie Bilder, die vom Benutzer gesendet werden. Für ausgehende Nachrichten enthält Objekte wie Karten oder Bilder, die an den Benutzer gesendet werden sollen.

attachments?: IAttachment[]

Eigenschaftswert

IAttachment[]

entities

Strukturierte Objekte, die an den Bot oder benutzer übergeben werden.

entities?: any[]

Eigenschaftswert

any[]

inputHint

Hinweis für Clients, die sie darüber informieren, ob der Bot weitere Eingaben erwartet oder nicht. Die integrierten Eingabeaufforderungen füllen diesen Wert automatisch für ausgehende Nachrichten auf.

inputHint?: string

Eigenschaftswert

string

libraryNamespace

(Optional) Namespace, der für lokalisierungs- und andere Zwecke verwendet werden soll. Dies ist standardmäßig der Namespace der Aufrufer.

libraryNamespace?: string

Eigenschaftswert

string

listStyle

(Optional) Typ der Liste, die für "PromptType.choice" gerendert werden soll. Standardwert ist ListStyle.auto.

listStyle?: ListStyle

Eigenschaftswert

ListStyle

localizationNamespace

veraltet stattdessen libraryNamespace- verwenden.

localizationNamespace?: string

Eigenschaftswert

string

maxLength

(Optional) Maximale Länge, die erkannt werden kann.

maxLength?: number

Eigenschaftswert

number

maxRetries

(Optional) maximale Anzahl von Malen, um den Benutzer erneut aufzufordern. Standardmäßig wird der Benutzer auf unbestimmte Zeit erneut aufgefordert.

maxRetries?: number

Eigenschaftswert

number

minLength

(Optional) Mindestlänge, die erkannt werden kann.

minLength?: number

Eigenschaftswert

number

prompt

(Optional) Anfängliche Eingabeaufforderung, um den Benutzer zu senden. Dies wird in der Regel von der funktion Prompts.xxx() aufgefüllt.

prompt?: TextOrMessageType

Eigenschaftswert

TextOrMessageType

promptAfterAction

(Optional) Flag, das zum Steuern der erneuten Eingabeaufforderung eines Benutzers verwendet wird, nachdem ein Dialogfeld durch eine Aktion gestartet wurde. Der Standardwert ist true.

promptAfterAction?: boolean

Eigenschaftswert

boolean

refDate

(Optional) Bezugsdatum beim Erkennen von Uhrzeiten. Datum, das in Teilstrichen mit Date.getTime() ausgedrückt wird.

refDate?: number

Eigenschaftswert

number

retryPrompt

(Optional) Wiederholen Sie die Aufforderung zum Senden, wenn die Benutzerantwort nicht verstanden wird. Standardmäßig wird nur eine erneute Eingabeaufforderung mit einer anpassbaren Systemaufforderung angezeigt.

retryPrompt?: TextOrMessageType

Eigenschaftswert

TextOrMessageType

retrySpeak

(Optional) SSML zum Senden mit dem retryPrompt. Wenn der RetryPrompt vom Typ IMessage oder IIsMessageist, wird dieser Wert ignoriert. Wenn dieser Wert ein Array ist, wird eine Antwort zufällig ausgewählt.

retrySpeak?: TextType

Eigenschaftswert

TextType

speak

(Optional) SSML zum Senden mit dem ursprünglichen prompt. Wenn die Eingabeaufforderung vom Typ IMessage oder IIsMessageist, wird dieser Wert ignoriert. Wenn dieser Wert ein Array ist, wird eine Antwort zufällig ausgewählt.

speak?: TextType

Eigenschaftswert

TextType

textFormat

Format von Textfeldern. Der Standardwert ist "markdown".

textFormat?: string

Eigenschaftswert

string