ChoiceInput class

ChoiceInput - 宣告式輸入，從使用者收集選項。

建構函式

ChoiceInput(string, Partial<Activity> | string)

初始化 InputDialog 類別的新實例

屬性

$kind
choiceOptions	傳遞至 `ChoiceFactory` 的其他選項，並用來調整呈現給用戶的選擇樣式。
choices	要向用戶呈現的選項清單。
defaultLocale	提示預設地區設定，應該辨識。
outputFormat	控制回應的格式（選擇的值或索引）。
recognizerOptions	傳遞至基礎 `recognizeChoices()` 函式的其他選項。
style	提示時呈現給使用者的「是」和「否」選項樣式。

繼承的屬性

allowInterruptions	中斷原則。
alwaysPrompt	值，指出輸入是否應該一律提示用戶，無論是否有值。
defaultValue	超過 maxTurnCount時輸入對話框的預設值。
defaultValueResponse	達到 maxTurnCount且使用預設值時要傳送的活動範本。
disabled	如果為 true 的選擇性運算式將會停用此動作。
EndOfTurn	取得預設回合結束結果。
id
invalidPrompt	每當提供的值無效或無效時，要傳送給用戶的活動範本。
maxTurnCount	在對話框放棄之前，要求使用者提供此值的次數上限。
OPTIONS_PROPERTY
prompt	要傳送給用戶的活動。
property	輸入要系結至的值表達式。
telemetryClient
TURN_COUNT_PROPERTY
unrecognizedPrompt	重試提示的活動範本。
validations	要執行以驗證輸入的表達式。
value	值運算式，可用來初始化輸入提示。
VALUE_PROPERTY

方法

getConverter(Object)

繼承的方法

beginDialog(DialogContext, any)	啟動對話框並推送至對話堆棧時呼叫。
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)	當子系 Dialog 完成回合時呼叫，將控制權傳回給這個對話方塊。

ChoiceInput(string, Partial<Activity> | string)

初始化 InputDialog 類別的新實例

new ChoiceInput(property?: string, prompt?: Partial<Activity> | string)

參數

property: string

自選。輸入要系結至的值表達式。

prompt: Partial<Activity> | string

自選。如果要傳送給使用者的 Activity，如果指定字串，則會具現化 activityTemplate。

$kind

static $kind: string

屬性值

string

choiceOptions

傳遞至 ChoiceFactory 的其他選項，並用來調整呈現給用戶的選擇樣式。

choiceOptions?: ObjectExpression<ChoiceFactoryOptions>

屬性值

ObjectExpression<ChoiceFactoryOptions>

choices

要向用戶呈現的選項清單。

choices: ObjectExpression<ChoiceSet>

屬性值

ObjectExpression<ChoiceSet>

defaultLocale

提示預設地區設定，應該辨識。

defaultLocale?: StringExpression

屬性值

StringExpression

outputFormat

控制回應的格式（選擇的值或索引）。

outputFormat: EnumExpression<ChoiceOutputFormat>

屬性值

EnumExpression<ChoiceOutputFormat>

recognizerOptions

傳遞至基礎 recognizeChoices() 函式的其他選項。

recognizerOptions?: ObjectExpression<FindChoicesOptions>

屬性值

ObjectExpression<FindChoicesOptions>

style

提示時呈現給使用者的「是」和「否」選項樣式。

style: EnumExpression<ListStyle>

屬性值

EnumExpression<ListStyle>

備註

預設為 ListStyle.auto。

allowInterruptions

中斷原則。

allowInterruptions: BoolExpression

屬性值

BoolExpression

繼承自InputDialog.allowInterruptions

alwaysPrompt

值，指出輸入是否應該一律提示用戶，無論是否有值。

alwaysPrompt: BoolExpression

屬性值

BoolExpression

繼承自InputDialog.alwaysPrompt

defaultValue

超過 maxTurnCount時輸入對話框的預設值。

defaultValue?: ValueExpression

屬性值

ValueExpression

繼承自InputDialog.defaultValue

defaultValueResponse

達到 maxTurnCount且使用預設值時要傳送的活動範本。

defaultValueResponse: TemplateInterface<Partial<Activity>, DialogStateManager>

屬性值

TemplateInterface<Partial<Activity>, DialogStateManager>

繼承自InputDialog.defaultValueResponse

disabled

如果為 true 的選擇性運算式將會停用此動作。

disabled?: BoolExpression

屬性值

BoolExpression

繼承自InputDialog.disabled

EndOfTurn

取得預設回合結束結果。

static EndOfTurn: DialogTurnResult

屬性值

DialogTurnResult

備註

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

繼承自 Dialog.EndOfTurn

id

id: string

屬性值

string

繼承自 Dialog.id

invalidPrompt

每當提供的值無效或無效時，要傳送給用戶的活動範本。

invalidPrompt: TemplateInterface<Partial<Activity>, DialogStateManager>

屬性值

TemplateInterface<Partial<Activity>, DialogStateManager>

繼承自InputDialog.invalidPrompt

maxTurnCount

在對話框放棄之前，要求使用者提供此值的次數上限。

maxTurnCount?: IntExpression

屬性值

IntExpression

繼承自InputDialog.maxTurnCount

OPTIONS_PROPERTY

static OPTIONS_PROPERTY: string

屬性值

string

繼承自InputDialog.OPTIONS_PROPERTY

prompt

要傳送給用戶的活動。

prompt: TemplateInterface<Partial<Activity>, DialogStateManager>

屬性值

TemplateInterface<Partial<Activity>, DialogStateManager>

繼承自InputDialog.prompt

property

輸入要系結至的值表達式。

property: StringExpression

屬性值

StringExpression

繼承自InputDialog.property

telemetryClient

telemetryClient: BotTelemetryClient

屬性值

BotTelemetryClient

繼承自 Dialog.telemetryClient

TURN_COUNT_PROPERTY

static TURN_COUNT_PROPERTY: string

屬性值

string

繼承自InputDialog.TURN_COUNT_PROPERTY

unrecognizedPrompt

重試提示的活動範本。

unrecognizedPrompt: TemplateInterface<Partial<Activity>, DialogStateManager>

屬性值

TemplateInterface<Partial<Activity>, DialogStateManager>

繼承自InputDialog.unrecognizedPrompt

validations

要執行以驗證輸入的表達式。

validations: string[]

屬性值

string[]

繼承自InputDialog.validations

value

值運算式，可用來初始化輸入提示。

value: ValueExpression

屬性值

ValueExpression

繼承自InputDialog.value

VALUE_PROPERTY

static VALUE_PROPERTY: string

屬性值

string

繼承自InputDialog.VALUE_PROPERTY

getConverter(Object)

function getConverter(property: Object): Converter | ConverterFactory

參數

property: Object

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

傳回

Converter | ConverterFactory

選取器組態的轉換器。

beginDialog(DialogContext, any)

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

function beginDialog(dc: DialogContext, options?: any): Promise<DialogTurnResult>

參數

dc: DialogContext

目前交談回合的 DialogContext。

options: any

自選。要傳遞至 Dialog的初始資訊。

傳回

Promise<DialogTurnResult>

代表異步操作 DialogTurnResultPromise。

繼承自InputDialog.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>

代表異步操作 DialogTurnResultPromise。

繼承自InputDialog.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)

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

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

參數

dc: DialogContext

目前交談回合的 DialogContext。

_reason: DialogReason

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

_result: any

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

傳回

Promise<DialogTurnResult>

代表異步操作 DialogTurnResultPromise。

繼承自InputDialog.resumeDialog

ChoiceInput class

建構函式

屬性

繼承的屬性

方法

繼承的方法

建構函式詳細資料

ChoiceInput(string, Partial<Activity> | string)

參數

屬性詳細資料

$kind

屬性值

choiceOptions

屬性值

choices

屬性值

defaultLocale

屬性值

outputFormat

屬性值

recognizerOptions

屬性值

style

屬性值

備註

繼承的屬性詳細資料

allowInterruptions

屬性值

alwaysPrompt

屬性值

defaultValue

屬性值

defaultValueResponse

屬性值

disabled

屬性值

EndOfTurn

屬性值

備註

id

屬性值

invalidPrompt

屬性值

maxTurnCount

屬性值

OPTIONS_PROPERTY

屬性值

prompt

屬性值

property

屬性值

telemetryClient

屬性值

TURN_COUNT_PROPERTY

屬性值

unrecognizedPrompt

屬性值

validations

屬性值

value

屬性值

VALUE_PROPERTY

屬性值

方法詳細資料

getConverter(Object)

參數

傳回

繼承的方法的詳細資料

beginDialog(DialogContext, any)

參數

傳回

configure(Record<string, unknown>)

參數

傳回

continueDialog(DialogContext)

參數

傳回

endDialog(TurnContext, DialogInstance, DialogReason)

參數

傳回