Partager via

IPromptChoiceOptions interface

  • Référence
Paquet:
botbuilder

Options passées à Prompts.choice() ou dans un appel session.beginDialog() à une invite personnalisée basée sur la classe PromptChoice.

Extends
IPromptOptions

Propriétés

attachmentLayout

Indicateur pour savoir comment les clients doivent mettre en page plusieurs pièces jointes. La valeur par défaut est « list ».
attachments

Pour les messages entrants contient des pièces jointes telles que des images envoyées par l’utilisateur. Pour les messages sortants contient des objets tels que des cartes ou des images à envoyer à l’utilisateur.
choices

(Facultatif) Liste des choix à présenter à l’utilisateur. En cas d’omission d’un gestionnaire PromptChoice.onChoices() doit être fourni.
entities

Objets structurés transmis au bot ou à l’utilisateur.
inputHint

Conseil pour les clients qui leur indiquent si le bot s’attend à une entrée supplémentaire ou non. Les invites intégrées remplissent automatiquement cette valeur pour les messages sortants.
libraryNamespace

(Facultatif) espace de noms à utiliser à des fins de localisation et d’autres fins. Cette valeur par défaut est l’espace de noms des appelants.
listStyle

(Facultatif) type de liste à afficher pour PromptType.choice. La valeur par défaut est ListStyle.auto.
localizationNamespace

DÉPRÉCIÉ utiliser libraryNamespace à la place.
maxRetries

(Facultatif) nombre maximal de fois pour inviter à nouveau l’utilisateur. Par défaut, l’utilisateur est invité indéfiniment.
prompt

(Facultatif) Invite initiale d’envoi de l’utilisateur. Il s’agit généralement de la fonction Prompts.xxx().
promptAfterAction

(Facultatif) indicateur utilisé pour contrôler la réinitulation d’un utilisateur après la fin d’une boîte de dialogue démarrée par une action. La valeur par défaut est true.
refDate

(Facultatif) date de référence lors de la reconnaissance des heures. Date exprimée en cycles à l’aide de Date.getTime().
retryPrompt

(Facultatif) invite de nouvelles tentatives à envoyer si la réponse des utilisateurs n’est pas comprise. Par défaut, il suffit de réinscrire avec une invite système personnalisable.
retrySpeak

(Facultatif) SSML à envoyer avec le retryPrompt. Si la nouvelle tentativePrompt est de type IMessage ou IIsMessage, cette valeur est ignorée. Si cette valeur est un tableau, une réponse est choisie au hasard.
speak

(Facultatif) SSML à envoyer avec la promptinitiale. Si l’invite est de type IMessage ou IIsMessage, cette valeur est ignorée. Si cette valeur est un tableau, une réponse est choisie au hasard.
textFormat

Format des champs de texte. La valeur par défaut est « markdown ».

Détails de la propriété

attachmentLayout

Indicateur pour savoir comment les clients doivent mettre en page plusieurs pièces jointes. La valeur par défaut est « list ».

attachmentLayout?: string

Valeur de propriété

string

attachments

Pour les messages entrants contient des pièces jointes telles que des images envoyées par l’utilisateur. Pour les messages sortants contient des objets tels que des cartes ou des images à envoyer à l’utilisateur.

attachments?: IAttachment[]

Valeur de propriété

IAttachment[]

choices

(Facultatif) Liste des choix à présenter à l’utilisateur. En cas d’omission d’un gestionnaire PromptChoice.onChoices() doit être fourni.

choices?: IChoice[]

Valeur de propriété

IChoice[]

entities

Objets structurés transmis au bot ou à l’utilisateur.

entities?: any[]

Valeur de propriété

any[]

inputHint

Conseil pour les clients qui leur indiquent si le bot s’attend à une entrée supplémentaire ou non. Les invites intégrées remplissent automatiquement cette valeur pour les messages sortants.

inputHint?: string

Valeur de propriété

string

libraryNamespace

(Facultatif) espace de noms à utiliser à des fins de localisation et d’autres fins. Cette valeur par défaut est l’espace de noms des appelants.

libraryNamespace?: string

Valeur de propriété

string

listStyle

(Facultatif) type de liste à afficher pour PromptType.choice. La valeur par défaut est ListStyle.auto.

listStyle?: ListStyle

Valeur de propriété

ListStyle

localizationNamespace

DÉPRÉCIÉ utiliser libraryNamespace à la place.

localizationNamespace?: string

Valeur de propriété

string

maxRetries

(Facultatif) nombre maximal de fois pour inviter à nouveau l’utilisateur. Par défaut, l’utilisateur est invité indéfiniment.

maxRetries?: number

Valeur de propriété

number

prompt

(Facultatif) Invite initiale d’envoi de l’utilisateur. Il s’agit généralement de la fonction Prompts.xxx().

prompt?: TextOrMessageType

Valeur de propriété

TextOrMessageType

promptAfterAction

(Facultatif) indicateur utilisé pour contrôler la réinitulation d’un utilisateur après la fin d’une boîte de dialogue démarrée par une action. La valeur par défaut est true.

promptAfterAction?: boolean

Valeur de propriété

boolean

refDate

(Facultatif) date de référence lors de la reconnaissance des heures. Date exprimée en cycles à l’aide de Date.getTime().

refDate?: number

Valeur de propriété

number

retryPrompt

(Facultatif) invite de nouvelles tentatives à envoyer si la réponse des utilisateurs n’est pas comprise. Par défaut, il suffit de réinscrire avec une invite système personnalisable.

retryPrompt?: TextOrMessageType

Valeur de propriété

TextOrMessageType

retrySpeak

(Facultatif) SSML à envoyer avec le retryPrompt. Si la nouvelle tentativePrompt est de type IMessage ou IIsMessage, cette valeur est ignorée. Si cette valeur est un tableau, une réponse est choisie au hasard.

retrySpeak?: TextType

Valeur de propriété

TextType

speak

(Facultatif) SSML à envoyer avec la promptinitiale. Si l’invite est de type IMessage ou IIsMessage, cette valeur est ignorée. Si cette valeur est un tableau, une réponse est choisie au hasard.

speak?: TextType

Valeur de propriété

TextType

textFormat

Format des champs de texte. La valeur par défaut est « markdown ».

textFormat?: string

Valeur de propriété

string