IPromptArgs interface

套件:

botbuilder

已淘汰 新的提示系統只會使用 IPromptOptions。

Extends

IPromptOptions

屬性

attachmentLayout	用戶端應如何配置多個附件的提示。 預設值為 『list』。
attachments	對於內送郵件，包含從用戶傳送的影像之類的附件。 對於傳出訊息，包含要傳送給使用者的卡片或影像等物件。
entities	傳遞至 Bot 或使用者的結構化物件。
enumsValues
inputHint	用戶端提示，讓他們知道 Bot 是否預期進一步輸入。 內建提示會自動為傳出訊息填入此值。
libraryNamespace	（選擇性） 命名空間，用於當地語系化和其他用途。 這會預設為呼叫端命名空間。
listStyle	（選擇性） 要轉譯的 PromptType.choice 列表類型。 默認值為 ListStyle.auto。
localizationNamespace	已被取代 請改用 libraryNamespace。
maxRetries	（選擇性） 重新提示使用者的次數上限。 根據預設，系統會無限期地重新提示使用者。
prompt	（選擇性）傳送使用者的初始提示。 這通常會由 Prompts.xxx() 函式填入。
promptAfterAction	（選擇性） 旗標，用來控制動作啟動對話框之後使用者重新提示。 默認值為 true。
promptType
refDate	（選擇性） 辨識時間時的參考日期。 使用 Date.getTime（） 以刻度表示的日期。
retryCnt
retryPrompt	（選擇性） 如果無法瞭解使用者回應，請重試提示傳送。 預設值只是使用可自定義的系統提示重新提示。
retrySpeak	（選擇性）要與 retryPrompt一起傳送的 SSML。 如果 retryPrompt 的類型為 IMessage 或 IIsMessage，則會忽略此值。 如果此值是陣列，則會隨機選擇回應。
speak	（選擇性）要與初始 prompt一起傳送的 SSML。 如果提示的類型為 IMessage 或 IIsMessage，則會忽略此值。 如果此值是陣列，則會隨機選擇回應。
textFormat	文字欄位格式。 默認值為 『Markdown』。

屬性詳細資料

attachmentLayout

用戶端應如何配置多個附件的提示。 預設值為 『list』。

attachmentLayout?: string

屬性值

string

attachments

對於內送郵件，包含從用戶傳送的影像之類的附件。 對於傳出訊息，包含要傳送給使用者的卡片或影像等物件。

attachments?: IAttachment[]

屬性值

IAttachment[]

entities

傳遞至 Bot 或使用者的結構化物件。

entities?: any[]

屬性值

any[]

enumsValues

enumsValues?: string[]

屬性值

string[]

inputHint

用戶端提示，讓他們知道 Bot 是否預期進一步輸入。 內建提示會自動為傳出訊息填入此值。

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

promptType

promptType: PromptType

屬性值

PromptType

refDate

（選擇性） 辨識時間時的參考日期。 使用 Date.getTime（） 以刻度表示的日期。

refDate?: number

屬性值

number

retryCnt

retryCnt?: 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