IPromptChoiceOptions interface

包:

botbuilder

传递给 Prompts.choice（） 的选项 或 session.beginDialog() 调用中基于 PromptChoice 类自定义提示。

扩展

IPromptOptions

属性

attachmentLayout	提示客户端应如何布局多个附件。 默认值为“list”。
attachments	对于传入邮件，包含附件，如从用户发送的图像。 对于传出消息，包含要发送给用户的卡片或图像等对象。
choices	（可选）要向用户显示的选项列表。 如果省略了 PromptChoice.onChoices（） 处理程序。
entities	传递给机器人或用户的结构化对象。
inputHint	客户端提示告知机器人是否需要进一步输入。 内置提示会自动为传出消息填充此值。
libraryNamespace	（可选）命名空间，用于本地化和其他目的。 这默认为调用方命名空间。
listStyle	（可选）要呈现的 PromptType.choice 的列表类型。 默认值为 ListStyle.auto。
localizationNamespace	弃用 改用 libraryNamespace。
maxRetries	（可选） 重新提示用户的最大次数。 默认情况下，将无限期地重新提示用户。
prompt	（可选）发送用户的初始提示。 这通常由 Prompts.xxx() 函数填充。
promptAfterAction	（可选）标志，用于控制在操作启动的对话结束后重新提示用户。 默认值为 true。
refDate	（可选）识别时间时的参考日期。 使用 Date.getTime（） 以时钟周期表示的日期。
retryPrompt	（可选）如果无法理解用户响应，则重试提示发送。 默认值只是使用可自定义的系统提示重新提示。
retrySpeak	（可选）要随 retryPrompt一起发送的 SSML 。 如果 retryPrompt 的类型为 IMessage 或 IIsMessage，则此值将被忽略。 如果此值是数组，则会随机选择响应。
speak	（可选）要随初始 prompt一起发送的 SSML 。 如果提示的类型为 IMessage 或 IIsMessage，则此值将被忽略。 如果此值是数组，则会随机选择响应。
textFormat	文本字段的格式。 默认值为“markdown”。

属性详细信息

attachmentLayout

提示客户端应如何布局多个附件。 默认值为“list”。

attachmentLayout?: string

属性值

string

attachments

对于传入邮件，包含附件，如从用户发送的图像。 对于传出消息，包含要发送给用户的卡片或图像等对象。

attachments?: IAttachment[]

属性值

IAttachment[]

choices

（可选）要向用户显示的选项列表。 如果省略了 PromptChoice.onChoices（） 处理程序。

choices?: IChoice[]

属性值

IChoice[]

entities

传递给机器人或用户的结构化对象。

entities?: any[]

属性值

any[]

inputHint

客户端提示告知机器人是否需要进一步输入。 内置提示会自动为传出消息填充此值。

inputHint?: string

属性值

string

libraryNamespace

（可选）命名空间，用于本地化和其他目的。 这默认为调用方命名空间。

libraryNamespace?: string

属性值

string

listStyle

（可选）要呈现的 PromptType.choice 的列表类型。 默认值为 ListStyle.auto。

listStyle?: ListStyle

属性值

ListStyle

localizationNamespace

弃用 改用 libraryNamespace。

localizationNamespace?: string

属性值

string

maxRetries

（可选） 重新提示用户的最大次数。 默认情况下，将无限期地重新提示用户。

maxRetries?: number

属性值

number

prompt

（可选）发送用户的初始提示。 这通常由 Prompts.xxx() 函数填充。

prompt?: TextOrMessageType

属性值

TextOrMessageType

promptAfterAction

（可选）标志，用于控制在操作启动的对话结束后重新提示用户。 默认值为 true。

promptAfterAction?: boolean

属性值

boolean

refDate

（可选）识别时间时的参考日期。 使用 Date.getTime（） 以时钟周期表示的日期。

refDate?: number

属性值

number

retryPrompt

（可选）如果无法理解用户响应，则重试提示发送。 默认值只是使用可自定义的系统提示重新提示。

retryPrompt?: TextOrMessageType

属性值

TextOrMessageType

retrySpeak

（可选）要随 retryPrompt一起发送的 SSML 。 如果 retryPrompt 的类型为 IMessage 或 IIsMessage，则此值将被忽略。 如果此值是数组，则会随机选择响应。

retrySpeak?: TextType

属性值

TextType

speak

（可选）要随初始 prompt一起发送的 SSML 。 如果提示的类型为 IMessage 或 IIsMessage，则此值将被忽略。 如果此值是数组，则会随机选择响应。

speak?: TextType

属性值

TextType

textFormat

文本字段的格式。 默认值为“markdown”。

textFormat?: string

属性值

string