SkillDialog class
特製化對話框，可將遠端呼叫包裝至技能。
- Extends
-
Dialog<Partial<BeginSkillDialogOptions>>
備註
beginDialog 中的 options 參數必須是 BeginSkillDialogOptions 實例，其中包含對話框的初始參數。
建構函式
| Skill |
可將遠端呼叫包裝至技能的範例對話方塊。 |
屬性
| id | 對話框的唯一標識碼。 設定對話框的唯一標識符。 |
| telemetry |
取得此對話框的遙測用戶端。 設定此對話框的遙測用戶端。 |
繼承的屬性
| End |
取得預設回合結束結果。 |
方法
| begin |
啟動技能對話並推送至對話堆疊時呼叫。 |
| continue |
當技能對話框 繼續時呼叫，其中它是使用中的對話方塊，而使用者會以新的 Activity回復。 |
| end |
當技能對話框結束時呼叫。 |
| reprompt |
當技能對話框應該重新提示使用者輸入時呼叫。 |
| resume |
當子技能對話框完成回合時呼叫，將控制權傳回給這個對話框。 |
繼承的方法
| configure(Record<string, unknown>) | 用於設定物件的 Fluent 方法。 |
| get |
|
| get |
編碼字串，用來協助在重新部署時偵測 Bot 變更。 |
| on |
使用 |
建構函式詳細資料
SkillDialog(SkillDialogOptions, string)
可將遠端呼叫包裝至技能的範例對話方塊。
new SkillDialog(dialogOptions: SkillDialogOptions, dialogId?: string)參數
- dialogOptions
- SkillDialogOptions
執行技能對話框的選項。
- dialogId
-
string
對話框的識別碼。
備註
beginDialog() 中的 options 參數必須是具有對話框初始參數的 SkillDialogArgs 物件。
屬性詳細資料
id
對話框的唯一標識碼。 設定對話框的唯一標識符。
string id屬性值
string
對話框的識別碼。
備註
如果未指定，系統就會自動產生此專案。
telemetryClient
取得此對話框的遙測用戶端。 設定此對話框的遙測用戶端。
BotTelemetryClient telemetryClient屬性值
BotTelemetryClient
要用於記錄的 BotTelemetryClient。
繼承的屬性詳細資料
EndOfTurn
取得預設回合結束結果。
static EndOfTurn: DialogTurnResult屬性值
備註
此結果表示對話（或對話內的邏輯步驟）已完成目前回合的處理，仍在使用中，而且正在等候更多輸入。
方法詳細資料
beginDialog(DialogContext, BeginSkillDialogOptions)
啟動技能對話並推送至對話堆疊時呼叫。
function beginDialog(dc: DialogContext, options: BeginSkillDialogOptions): Promise<DialogTurnResult>參數
目前交談回合的 DialogContext。
- options
- BeginSkillDialogOptions
要傳遞至對話框的初始資訊。
傳回
Promise<DialogTurnResult>
代表異步操作的 Promise。
備註
如果工作成功，結果會指出對話在對話框處理回合之後是否仍在使用中。
continueDialog(DialogContext)
當技能對話框 繼續時呼叫，其中它是使用中的對話方塊，而使用者會以新的 Activity回復。
function continueDialog(dc: DialogContext): Promise<DialogTurnResult>參數
目前交談回合的 DialogContext。
傳回
Promise<DialogTurnResult>
代表異步操作的 Promise。
備註
如果工作成功，結果會指出對話在對話框處理回合之後是否仍在使用中。 結果也可能包含傳回值。
endDialog(TurnContext, DialogInstance, DialogReason)
當技能對話框結束時呼叫。
function endDialog(context: TurnContext, instance: DialogInstance, reason: DialogReason): Promise<void>參數
- context
-
TurnContext
這個回合 TurnContext 物件。
- instance
- DialogInstance
與對話框堆疊上這個對話框實例相關聯的狀態資訊。
- reason
- DialogReason
（xref：botbuilder-dialogs.DialogReason） 對話框結束的原因。
傳回
Promise<void>
代表異步操作的 Promise。
repromptDialog(TurnContext, DialogInstance)
當技能對話框應該重新提示使用者輸入時呼叫。
function repromptDialog(context: TurnContext, instance: DialogInstance): Promise<void>參數
- context
-
TurnContext
這個回合 TurnContext 物件。
- instance
- DialogInstance
此對話框的狀態資訊。
傳回
Promise<void>
代表異步操作的 Promise。
resumeDialog(DialogContext, DialogReason, any)
當子技能對話框完成回合時呼叫，將控制權傳回給這個對話框。
function resumeDialog(dc: DialogContext, _reason: DialogReason, _result?: any): Promise<DialogTurnResult>參數
交談目前回合的 DialogContext。
- _reason
- DialogReason
（xref：botbuilder-dialogs.DialogReason） 對話繼續的原因。
- _result
-
any
選擇性值，從呼叫的對話框傳回的值。 傳回之值的型別取決於子對話框。
傳回
Promise<DialogTurnResult>
代表異步操作的 Promise。
繼承的方法的詳細資料
configure(Record<string, unknown>)
用於設定物件的 Fluent 方法。
function configure(config: Record<string, unknown>): this參數
- config
-
Record<string, unknown>
要套用的組態設定。
傳回
this
作業完成之後 可設定。
getConverter(string)
function getConverter(_property: string): Converter | ConverterFactory參數
- _property
-
string
條件式選取器組態的索引鍵。
傳回
選取器組態的轉換器。
getVersion()
編碼字串，用來協助在重新部署時偵測 Bot 變更。
function getVersion(): string傳回
string
唯一的字串，只有在對話框以應該重新啟動對話框的方式變更時才會變更。
備註
這預設會傳回對話框 標識子，但可以覆寫以提供更精確的變更偵測邏輯。 堆疊上具有其版本變更的任何對話框都會引發 versionChanged 事件。 如果 Bot 未處理此事件，則會擲回錯誤，導致 Bot 錯誤處理程式邏輯正在執行。
傳回空字串將會一起停用元件的版本追蹤。
onDialogEvent(DialogContext, DialogEvent)
使用 DialogContext.emitEvent()引發事件時，由目前對話框或目前對話框啟動的對話框呼叫。
function onDialogEvent(dc: DialogContext, e: DialogEvent): Promise<boolean>參數
目前交談回合的對話內容。
要引發的事件。
傳回
Promise<boolean>
True 是表示 如果事件是由目前的對話框處理，且反升應該停止。