Case class

套件:

botbuilder-dialogs-adaptive

動作範圍的案例。

Extends

ActionScope

建構函式

Case(string, Dialog[])

初始化 Case 類別的新實例。

屬性

value

取得或設定要與條件比較的值表達式。

繼承的屬性

actions	要執行的動作。
EndOfTurn	取得預設回合結束結果。
id
telemetryClient

繼承的方法

beginDialog(DialogContext, O)	啟動 對話框 並推送至對話堆棧時呼叫。
configure(Record<string, unknown>)	用於設定物件的 Fluent 方法。
continueDialog(DialogContext)	當 對話框繼續時呼叫，其中它是使用中的對話框，而使用者會以新的活動回復。
endDialog(TurnContext, DialogInstance, DialogReason)	在衍生類別中覆寫時，會在對話結束之前執行清除。
getConverter(Object)
getDependencies()	取得子系 對話框 相依性，以便將其新增至 Dialog 集的容器。
getVersion()	取得代表這個對話框版本的唯一 string。 如果之間的版本變更，對話系統將會發出 DialogChanged 事件。
onDialogEvent(DialogContext, DialogEvent)	使用 DialogContext.emitEvent()引發事件時，由目前對話框或目前對話框啟動的對話框呼叫。
repromptDialog(TurnContext, DialogInstance)	在衍生類別中覆寫時，將使用者重新命名為輸入。
resumeDialog(DialogContext, DialogReason, any)	當子系 Dialog 完成回合時呼叫，將控制權傳回給這個對話方塊。

建構函式詳細資料

Case(string, Dialog[])

初始化 Case 類別的新實例。

new Case(value?: string, actions?: Dialog[])

參數

value

string

自選。 案例的字串值。

actions

Dialog[]

自選。 對話框 動作的可 numerable 清單。

屬性詳細資料

value

取得或設定要與條件比較的值表達式。

value: string

屬性值

string

繼承的屬性詳細資料

actions

要執行的動作。

actions: Dialog[]

屬性值

Dialog[]

繼承自ActionScope.actions

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>

參數

dc

DialogContext

目前交談回合的 DialogContext。

_options

O

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

傳回

Promise<DialogTurnResult>

表示異步操作的 Promise。

繼承自ActionScope.beginDialog

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

目前交談回合的 DialogContext。

傳回

Promise<DialogTurnResult>

表示異步操作的 Promise。

繼承自ActionScope.continueDialog

endDialog(TurnContext, DialogInstance, DialogReason)

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

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

參數

_context

TurnContext

回合的內容物件。

_instance

DialogInstance

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

_reason

DialogReason

對話框結束的原因。

傳回

Promise<void>

備註

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

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

另請參閱

• DialogContext.cancelAllDialogs
• DialogContext.endDialog
• DialogContext.replaceDialog

繼承自 Dialog.endDialog

getConverter(Object)

function getConverter(property: Object): Converter | ConverterFactory

參數

property

Object

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

傳回

Converter | ConverterFactory

選取器組態的轉換器。

繼承自ActionScope.getConverter

getDependencies()

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

function getDependencies(): Dialog[]

傳回

Dialog[]

子 對話框 相依性。

繼承自ActionScope.getDependencies

getVersion()

取得代表這個對話框版本的唯一 string。 如果之間的版本變更，對話系統將會發出 DialogChanged 事件。

function getVersion(): string

傳回

string

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

繼承自ActionScope.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 當目前的對話框應該重新要求使用者輸入時，就會呼叫此方法。 這個方法會針對提示對話框實作。

另請參閱

• DialogContext.repromptDialog
• 提示

繼承自 Dialog.repromptDialog

resumeDialog(DialogContext, DialogReason, any)

當子系 Dialog 完成回合時呼叫，將控制權傳回給這個對話方塊。

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

參數

dc

DialogContext

目前交談回合的 DialogContext。

_reason

DialogReason

（xref：botbuilder-dialogs.DialogReason），對話繼續的原因。

result

any

自選。 從呼叫的對話框傳回的值。 傳回之值的型別取決於子對話框。

傳回

Promise<DialogTurnResult>

表示異步操作的 Promise。

繼承自ActionScope.resumeDialog