ForEachPage class

パッケージ:

botbuilder-dialogs-adaptive

インメモリ リストまたはコレクション内の結果の各ページに対して一連のアクションを 1 回実行します。

Extends

ActionScope<O>

注釈

プロパティ のリストまたはコレクション ページに分割され、ループの反復ごとに に格納されます。 各ページのサイズは、maxSize によって決定され、既定では 10 のサイズになります。 EndDialog または GotoDialog アクションを含めることで、ループを早期に終了できます。

コンストラクター

ForEachPage()

プロパティ

$kind
disabled	true の場合は、このアクションを無効にする省略可能な式。
itemsProperty	列挙する必要があるリストを計算するために使用される式。
page	列挙する必要があるリストを計算するために使用される式。
pageIndex	列挙する必要があるリストを計算するために使用される式。
pageSize	ページ サイズ。既定値は 10 です。

継承されたプロパティ

actions	実行するアクション。
EndOfTurn	既定のターン終了の結果を取得します。
id
telemetryClient

メソッド

beginDialog(DialogContext, O)	新しい ダイアログ を開始し、ダイアログ スタックにプッシュします。
getConverter(Object)
getDependencies()	子 ダイアログ 依存関係を取得し、ダイアログ セット コンテナーに追加できるようにします。

継承されたメソッド

configure(Record<string, unknown>)	オブジェクトを構成するための Fluent メソッド。
continueDialog(DialogContext)	ダイアログ が継続 場合に呼び出されます。このダイアログはアクティブなダイアログで、ユーザーは新しいアクティビティで応答します。
endDialog(TurnContext, DialogInstance, DialogReason)	派生クラスでオーバーライドされると、ダイアログが終了する前にクリーンアップを実行します。
getVersion()	このダイアログのバージョンを表す一意の string を取得します。 バージョンが変更された場合、ダイアログ システムは DialogChanged イベントを生成します。
onDialogEvent(DialogContext, DialogEvent)	現在のダイアログまたは現在のダイアログが開始したダイアログによって、DialogContext.emitEvent()を使用してイベントが発生したときに呼び出されます。
repromptDialog(TurnContext, DialogInstance)	派生クラスでオーバーライドされると、ユーザーに入力を要求します。
resumeDialog(DialogContext, DialogReason, any)	子 ダイアログ ターンが完了し、このダイアログに制御が返されたときに呼び出されます。

コンストラクターの詳細

ForEachPage()

new ForEachPage()

プロパティの詳細

$kind

static $kind: string

プロパティ値

string

disabled

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

disabled?: BoolExpression

プロパティ値

BoolExpression

itemsProperty

列挙する必要があるリストを計算するために使用される式。

itemsProperty: StringExpression

プロパティ値

StringExpression

page

列挙する必要があるリストを計算するために使用される式。

page: StringExpression

プロパティ値

StringExpression

pageIndex

列挙する必要があるリストを計算するために使用される式。

pageIndex: StringExpression

プロパティ値

StringExpression

pageSize

ページ サイズ。既定値は 10 です。

pageSize: IntExpression

プロパティ値

IntExpression

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

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。

getConverter(Object)

function getConverter(property: Object): Converter | ConverterFactory

パラメーター

property

Object

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

戻り値

Converter | ConverterFactory

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

getDependencies()

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

function getDependencies(): Dialog[]

戻り値

Dialog[]

子 ダイアログ 依存関係。

継承済みメソッドの詳細

configure(Record<string, unknown>)

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

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

パラメーター

config

Record<string, unknown>

適用する構成設定。

戻り値

this

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

継承 構成可能。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 から継承された

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)

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

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