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()	子 ダイアログ の依存関係を取得して、コンテナー ダイアログ セットに追加できるようにします。
getVersion()	このダイアログのバージョンを表す一意の string を取得します。 バージョンが変更された場合、ダイアログ システムは DialogChanged イベントを生成します。
onDialogEvent(DialogContext, DialogEvent)	現在のダイアログまたは現在のダイアログが開始したダイアログによって、 DialogContext.emitEvent()を使用してイベントが発生したときに呼び出されます。
repromptDialog(TurnContext, DialogInstance)	派生クラスでオーバーライドされると、ユーザーに入力を要求します。
resumeDialog(DialogContext, DialogReason, any)	子ダイアログがターンを完了し、この ダイアログ にコントロールを返したときに呼び出されます。

コンストラクターの詳細

Case(string, Dialog[])

Case クラスの新しいインスタンスを初期化します。

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

パラメーター

value

string

随意。 Case の文字列値。

actions

Dialog[]

随意。 ダイアログ アクションの Numerable リスト。

プロパティの詳細

value

条件と比較する値式を取得または設定します。

value: string

プロパティ値

string

継承されたプロパティの詳細

actions

実行するアクション。

actions: Dialog[]

プロパティ値

Dialog[]

ActionScope.actionsから継承

EndOfTurn

既定のターン終了の結果を取得します。

static EndOfTurn: DialogTurnResult

プロパティ値

DialogTurnResult

注釈

この結果は、ダイアログ (またはダイアログ内の論理ステップ) が現在のターンの処理を完了し、まだアクティブであり、より多くの入力を待機していることを示します。

Inherited From Dialog.EndOfTurn

id

id: string

プロパティ値

string

Dialog.id から継承

telemetryClient

telemetryClient: BotTelemetryClient

プロパティ値

BotTelemetryClient

Inherited From 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

操作の完了後に 構成可能 。

Inherited From 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

Inherited From Dialog.endDialog

getConverter(Object)

function getConverter(property: Object): Converter | ConverterFactory

パラメーター

property

Object

条件付きセレクター構成のキー。

返品

Converter | ConverterFactory

セレクター構成のコンバーター。

ActionScope.getConverterから継承

getDependencies()

子 ダイアログ の依存関係を取得して、コンテナー ダイアログ セットに追加できるようにします。

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 の 場合は、イベントが現在のダイアログで処理され、バブルを停止する必要があります。

Inherited From Dialog.onDialogEvent

repromptDialog(TurnContext, DialogInstance)

派生クラスでオーバーライドされると、ユーザーに入力を要求します。

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

パラメーター

_context

TurnContext

ターンのコンテキスト オブジェクト。

_instance

DialogInstance

このダイアログの現在の状態情報。

返品

Promise<void>

注釈

検証ロジックと再プロンプト ロジックをサポートする派生ダイアログは、このメソッドをオーバーライドする必要があります。 既定では、このメソッドは無効です。

現在のダイアログがユーザーからの入力を要求し直す必要がある場合、DialogContext はこのメソッドを呼び出します。 このメソッドは、プロンプト ダイアログ用に実装されます。

関連項目

• DialogContext.repromptDialog
• プロンプト

Inherited From Dialog.repromptDialog

resumeDialog(DialogContext, DialogReason, any)

子ダイアログがターンを完了し、この ダイアログ にコントロールを返したときに呼び出されます。

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から継承