ForEach class

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

new ForEach()

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

new ForEach(itemsProperty: string, actions: Dialog[])

パラメーター

static $kind: string

プロパティ値

true の場合は、このアクションを無効にする省略可能な式。

disabled?: BoolExpression

プロパティ値

項目インデックスへのプロパティ パス式。

index: StringExpression

プロパティ値

項目のコレクションへのプロパティ パス式。

itemsProperty: StringExpression

プロパティ値

アイテム値へのプロパティ パス式。

value: StringExpression

プロパティ値

実行するアクション。

actions: Dialog[]

プロパティ値

ActionScope.actions から継承された

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

static EndOfTurn: DialogTurnResult

プロパティ値

注釈

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

Dialog.EndOfTurn から継承された

id: string

プロパティ値

Dialog.id から継承された

telemetryClient: BotTelemetryClient

プロパティ値

Dialog.telemetryClient から継承された

新しい ダイアログ を開始し、ダイアログ スタックにプッシュします。

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

パラメーター

返品

非同期操作を表す Promise。

function getConverter(property: Object): Converter | ConverterFactory

パラメーター

返品

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

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

function getDependencies(): Dialog[]

返品

子 ダイアログ 依存関係。

オブジェクトを構成するための Fluent メソッド。

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

パラメーター

返品

操作が完了した後の 構成可能な。

継承 構成可能。configure

ダイアログ が継続 場合に呼び出されます。このダイアログはアクティブなダイアログで、ユーザーは新しいアクティビティで応答します。

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

パラメーター

返品

非同期操作を表す Promise。

ActionScope.continueDialog から継承された

派生クラスでオーバーライドされると、ダイアログが終了する前にクリーンアップを実行します。

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

パラメーター

返品

注釈

終了する前にログ記録またはクリーンアップを実行する必要がある派生ダイアログは、このメソッドをオーバーライドする必要があります。 既定では、このメソッドは無効です。

DialogContext は、現在のダイアログが終了するときにこのメソッドを呼び出します。

も参照

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

Dialog.endDialog から継承された

このダイアログのバージョンを表す一意の string を取得します。 バージョンが変更された場合、ダイアログ システムは DialogChanged イベントを生成します。

function getVersion(): string

返品

ダイアログを再起動する方法でダイアログが変更された場合にのみ変更する必要がある一意の string。

ActionScope.getVersion から継承された

現在のダイアログまたは現在のダイアログが開始したダイアログによって、DialogContext.emitEvent()を使用してイベントが発生したときに呼び出されます。

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

パラメーター

返品

True の 場合は、イベントが現在のダイアログで処理され、バブルを停止する必要があります。

Dialog.onDialogEvent から継承された

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

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

パラメーター

返品

注釈

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

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

も参照

• DialogContext.repromptDialog
• プロンプト

Dialog.repromptDialog から継承された

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

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

パラメーター

返品

非同期操作を表す Promise。

actionScope.resumeDialog から継承