BaseInvokeDialog class

呼叫另一個對話框的動作。

建構函式

初始化 BaseInvokeDialog 類別的新實例。

屬性

activityProcessed	值，指出是否應該讓新的對話框處理活動。
dialog	要呼叫的對話框。
options	對話框的可設定選項。

繼承的屬性

EndOfTurn	取得預設回合結束結果。
id
telemetryClient

方法

beginDialog(DialogContext, O)	啟動對話框並推送至對話堆棧時呼叫。
getConverter(Object)
getDependencies()	取得子系對話框相依性，以便將其新增至 Dialog 集的容器。

繼承的方法

configure(Record<string, unknown>)	用於設定物件的 Fluent 方法。
continueDialog(DialogContext)	在衍生類別中覆寫時，繼續對話。
endDialog(TurnContext, DialogInstance, DialogReason)	在衍生類別中覆寫時，會在對話結束之前執行清除。
getVersion()	編碼字串，用來協助在重新部署時偵測 Bot 變更。
onDialogEvent(DialogContext, DialogEvent)	使用 `DialogContext.emitEvent()`引發事件時，由目前對話框或目前對話框啟動的對話框呼叫。
repromptDialog(TurnContext, DialogInstance)	在衍生類別中覆寫時，將使用者重新命名為輸入。
resumeDialog(DialogContext, DialogReason, any)	在衍生類別中覆寫時，在堆疊上對話框完成之後繼續對話。

BaseInvokeDialog(string, O)

初始化 BaseInvokeDialog 類別的新實例。

new BaseInvokeDialog(dialogIdToCall?: string, bindingOptions?: O)

參數

dialogIdToCall: string

對話框識別碼。

bindingOptions: O

（選擇性）系結選項。

activityProcessed

值，指出是否應該讓新的對話框處理活動。

activityProcessed: BoolExpression

屬性值

BoolExpression

dialog

要呼叫的對話框。

dialog: DialogExpression

屬性值

DialogExpression

options

對話框的可設定選項。

options: ObjectExpression<object>

屬性值

ObjectExpression<object>

EndOfTurn

取得預設回合結束結果。

static EndOfTurn: DialogTurnResult

屬性值

DialogTurnResult

備註

此結果表示對話（或對話內的邏輯步驟）已完成目前回合的處理，仍在使用中，而且正在等候更多輸入。

繼承自 Dialog.EndOfTurn

id

id: string

屬性值

string

繼承自 Dialog.id

telemetryClient

telemetryClient: BotTelemetryClient

屬性值

BotTelemetryClient

繼承自 Dialog.telemetryClient

beginDialog(DialogContext, O)

啟動對話框並推送至對話堆棧時呼叫。

function beginDialog(_dc: DialogContext, _options?: O): Promise<DialogTurnResult<any>>

參數

_dc: DialogContext

目前交談回合的 DialogContext。

_options: O

自選。要傳遞至對話框的初始資訊。

傳回

Promise<DialogTurnResult<any>>

備註

未實作的方法。

getConverter(Object)

function getConverter(property: Object): Converter | ConverterFactory

參數

property: Object

條件式選取器組態的索引鍵。

傳回

Converter | ConverterFactory

選取器組態的轉換器。

getDependencies()

取得子系對話框相依性，以便將其新增至 Dialog 集的容器。

function getDependencies(): Dialog<__type>[]

傳回

Dialog<__type>[]

子對話框相依性。

configure(Record<string, unknown>)

用於設定物件的 Fluent 方法。

function configure(config: Record<string, unknown>): this

參數

config: Record<string, unknown>

要套用的組態設定。

傳回

this

作業完成之後可設定。

繼承自 Configure.configure

continueDialog(DialogContext)

在衍生類別中覆寫時，繼續對話。

function continueDialog(dc: DialogContext): Promise<DialogTurnResult>

參數

dc: DialogContext

目前對話框回合的內容。

傳回

Promise<DialogTurnResult>

解決對話框回合結果的承諾。

備註

支援多回合交談的衍生對話應該覆寫此方法。根據預設，這個方法會發出對話框已完成並傳回的訊號。

DialogContext 在繼續對話時呼叫此方法。

若要向對話框內容發出訊號，表示此對話框已完成，請在結束此方法之前，先等候 dialogContext.endDialog 。

另請參閱

DialogContext.continueDialog

繼承自 Dialog.continueDialog

endDialog(TurnContext, DialogInstance, DialogReason)

在衍生類別中覆寫時，會在對話結束之前執行清除。

function endDialog(_context: TurnContext, _instance: DialogInstance, _reason: DialogReason): Promise<void>

參數

_context: TurnContext

回合的內容物件。

_instance: DialogInstance

此對話框的目前狀態資訊。

_reason: DialogReason

對話框結束的原因。

傳回

Promise<void>

備註

需要在結束之前執行記錄或清除的衍生對話應該覆寫此方法。根據預設，這個方法沒有任何作用。

DialogContext 目前對話框結束時呼叫這個方法。

另請參閱

繼承自 Dialog.endDialog

getVersion()

編碼字串，用來協助在重新部署時偵測 Bot 變更。

function getVersion(): string

傳回

string

唯一的字串，只有在對話框以應該重新啟動對話框的方式變更時才會變更。

備註

這預設會傳回對話框標識子，但可以覆寫以提供更精確的變更偵測邏輯。堆疊上具有其版本變更的任何對話框都會引發 versionChanged 事件。如果 Bot 未處理此事件，則會擲回錯誤，導致 Bot 錯誤處理程式邏輯正在執行。

傳回空字串將會一起停用元件的版本追蹤。

繼承自 Dialog.getVersion

onDialogEvent(DialogContext, DialogEvent)

使用 DialogContext.emitEvent()引發事件時，由目前對話框或目前對話框啟動的對話框呼叫。

function onDialogEvent(dc: DialogContext, e: DialogEvent): Promise<boolean>

參數

dc: DialogContext

目前交談回合的對話內容。

e: DialogEvent

要引發的事件。

傳回

Promise<boolean>

True 是表示如果事件是由目前的對話框處理，且反升應該停止。

繼承自 Dialog.onDialogEvent

repromptDialog(TurnContext, DialogInstance)

在衍生類別中覆寫時，將使用者重新命名為輸入。

function repromptDialog(_context: TurnContext, _instance: DialogInstance): Promise<void>

參數

_context: TurnContext

回合的內容物件。

_instance: DialogInstance

此對話框的目前狀態資訊。

傳回

Promise<void>

備註

支持驗證和重新提示邏輯的衍生對話應該覆寫此方法。根據預設，這個方法沒有任何作用。

DialogContext 當目前的對話框應該重新要求使用者輸入時，就會呼叫此方法。這個方法會針對提示對話框實作。

另請參閱

繼承自 Dialog.repromptDialog

resumeDialog(DialogContext, DialogReason, any)

在衍生類別中覆寫時，在堆疊上對話框完成之後繼續對話。

function resumeDialog(dc: DialogContext, reason: DialogReason, result?: any): Promise<DialogTurnResult>

參數

dc: DialogContext

目前對話框回合的內容。

reason: DialogReason

對話繼續的原因。這通常會 DialogReason.endCalled

result: any

自選。結束之對話框的傳回值，如果有的話。

傳回

Promise<DialogTurnResult>

解決對話框回合結果的承諾。

備註

支援多回合交談的衍生對話應該覆寫此方法。根據預設，這個方法會發出對話框已完成並傳回的訊號。

DialogContext 在繼續對話時呼叫此方法。如果堆疊上的上一個對話框傳回值，該值會位於 result 參數中。

若要啟動子對話框，請使用 DialogContext.beginDialog 或 DialogContext.prompt;不過，此對話框不一定是啟動子對話的對話框。若要向對話框內容發出訊號，表示此對話框已完成，請在結束此方法之前，先等候 dialogContext.endDialog 。

另請參閱

DialogContext.endDialog

繼承自 Dialog.resumeDialog

BaseInvokeDialog class

建構函式

屬性

繼承的屬性

方法

繼承的方法

建構函式詳細資料

BaseInvokeDialog(string, O)

參數

屬性詳細資料

activityProcessed

屬性值

dialog

屬性值

options

屬性值

繼承的屬性詳細資料

EndOfTurn

屬性值

備註

id

屬性值

telemetryClient

屬性值

方法詳細資料

beginDialog(DialogContext, O)

參數

傳回

備註

getConverter(Object)

參數

傳回

getDependencies()

傳回

繼承的方法的詳細資料

configure(Record<string, unknown>)

參數

傳回

continueDialog(DialogContext)

參數

傳回

備註

endDialog(TurnContext, DialogInstance, DialogReason)

參數

傳回

備註

getVersion()

傳回

備註

onDialogEvent(DialogContext, DialogEvent)

參數

傳回

repromptDialog(TurnContext, DialogInstance)

參數

傳回

備註

resumeDialog(DialogContext, DialogReason, any)

參數

傳回

備註