DialogContainer class

パッケージ:

botbuilder-dialogs

一連のダイアログのコンテナー。

Extends

Dialog<O>

コンストラクター

DialogContainer(string)

Dialog クラスの新しいインスタンスを作成します。

プロパティ

dialogs	コンテナー ダイアログ セット。
id	ダイアログの一意の ID。 ダイアログの一意の ID を設定します。
telemetryClient	テレメトリ クライアントを設定し、すべての子ダイアログにも適用します。 コンポーネントに追加された今後のダイアログも、このクライアントを継承します。 現在のテレメトリ クライアントを取得します。

継承されたプロパティ

EndOfTurn

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

メソッド

createChildContext(DialogContext)	コンテナーのアクティブな子の内部ダイアログ コンテキストを作成します。
findDialog(string)	以前にコンテナーに追加された子ダイアログを検索します。
onDialogEvent(DialogContext, DialogEvent)	現在のダイアログまたは現在のダイアログが開始したダイアログによって、DialogContext.emitEvent()を使用してイベントが発生したときに呼び出されます。

継承されたメソッド

beginDialog(DialogContext, O)	派生クラスでオーバーライドされると、ダイアログを開始します。
configure(Record<string, unknown>)	オブジェクトを構成するための Fluent メソッド。
continueDialog(DialogContext)	派生クラスでオーバーライドされた場合は、ダイアログを続行します。
endDialog(TurnContext, DialogInstance, DialogReason)	派生クラスでオーバーライドされると、ダイアログが終了する前にクリーンアップを実行します。
getConverter(string)
getVersion()	再デプロイ時のボットの変更の検出に役立つエンコードされた文字列。
repromptDialog(TurnContext, DialogInstance)	派生クラスでオーバーライドされると、ユーザーに入力を要求します。
resumeDialog(DialogContext, DialogReason, any)	派生クラスでオーバーライドされると、スタック上のダイアログが完了した後にダイアログを再開します。

コンストラクターの詳細

DialogContainer(string)

Dialog クラスの新しいインスタンスを作成します。

new DialogContainer(dialogId?: string)

パラメーター

dialogId

string

随意。 ダイアログの一意の ID。

プロパティの詳細

dialogs

コンテナー ダイアログ セット。

dialogs: DialogSet

プロパティ値

DialogSet

id

ダイアログの一意の ID。 ダイアログの一意の ID を設定します。

string id

プロパティ値

string

ダイアログの ID。

注釈

これは、指定されていない場合は自動的に生成されます。

telemetryClient

テレメトリ クライアントを設定し、すべての子ダイアログにも適用します。 コンポーネントに追加された今後のダイアログも、このクライアントを継承します。 現在のテレメトリ クライアントを取得します。

BotTelemetryClient telemetryClient

プロパティ値

BotTelemetryClient

ログ記録に使用する BotTelemetryClient。

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

EndOfTurn

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

static EndOfTurn: DialogTurnResult

プロパティ値

DialogTurnResult

注釈

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

Dialog.EndOfTurn から継承された

メソッドの詳細

createChildContext(DialogContext)

コンテナーのアクティブな子の内部ダイアログ コンテキストを作成します。

function createChildContext(dc: DialogContext): DialogContext | undefined

パラメーター

dc

DialogContext

[親] ダイアログ コンテキスト。

戻り値

DialogContext | undefined

アクティブな子の新しいダイアログ コンテキスト。アクティブな子がない場合は undefined。

findDialog(string)

以前にコンテナーに追加された子ダイアログを検索します。

function findDialog(dialogId: string): Dialog | undefined

パラメーター

dialogId

string

参照するダイアログの ID。

戻り値

Dialog | undefined

見つかった場合のダイアログ。それ以外の場合は null。

onDialogEvent(DialogContext, DialogEvent)

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

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

パラメーター

dc

DialogContext

会話の現在のターンのダイアログ コンテキスト。

e

DialogEvent

発生しているイベント。

戻り値

Promise<boolean>

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

継承済みメソッドの詳細

beginDialog(DialogContext, O)

派生クラスでオーバーライドされると、ダイアログを開始します。

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

パラメーター

dc

DialogContext

現在のダイアログ ターンのコンテキスト。

options

O

随意。 ダイアログの開始時に使用する引数。

戻り値

Promise<DialogTurnResult>

注釈

派生ダイアログは、このメソッドをオーバーライドする必要があります。

DialogContext は、このダイアログの新しい DialogInstance を作成し、ダイアログ スタックにプッシュしてダイアログを開始するときに、このメソッドを呼び出します。

1 ターンの会話を表すダイアログは、このメソッドを終了する前 DialogContext.endDialog を待機する必要があります。

も参照

• DialogContext.beginDialog
• DialogContext.replaceDialog

Dialog.beginDialog から継承された

configure(Record<string, unknown>)

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

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

パラメーター

config

Record<string, unknown>

適用する構成設定。

戻り値

this

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

継承構成可能。構成

continueDialog(DialogContext)

派生クラスでオーバーライドされた場合は、ダイアログを続行します。

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

パラメーター

dc

DialogContext

現在のダイアログ ターンのコンテキスト。

戻り値

Promise<DialogTurnResult>

ダイアログ ターンの結果を解決する Promise。

注釈

複数ターンの会話をサポートする派生ダイアログは、このメソッドをオーバーライドする必要があります。 既定では、このメソッドはダイアログが完了したことを通知し、返します。

DialogContext は、ダイアログを続行するときにこのメソッドを呼び出します。

このダイアログが完了したことをダイアログ コンテキストに通知するには、このメソッドを終了する前に DialogContext.endDialog 待機します。

も参照

• DialogContext.continueDialog

Dialog.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(string)

function getConverter(_property: string): Converter | ConverterFactory

パラメーター

_property

string

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

戻り値

Converter | ConverterFactory

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

継承元構成可能な.getConverter

getVersion()

再デプロイ時のボットの変更の検出に役立つエンコードされた文字列。

function getVersion(): string

戻り値

string

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

注釈

既定では、id ダイアログが返されますが、より正確な変更検出ロジックを提供するためにオーバーライドできます。 バージョンが変更されたスタック上のダイアログでは、versionChanged イベントが発生します。 このイベントがボットによって処理されない場合は、エラーがスローされ、ボットのエラー ハンドラー ロジックが実行されます。

空の文字列を返すと、コンポーネントのバージョン追跡がすべて無効になります。

Dialog.getVersion から継承された

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

現在のダイアログ ターンのコンテキスト。

reason

DialogReason

ダイアログが再開される理由。 これは通常、DialogReason.endCalled されます。

result

any

随意。 終了したダイアログからの戻り値 (存在する場合)。

戻り値

Promise<DialogTurnResult>

ダイアログ ターンの結果を解決する Promise。

注釈

複数ターンの会話をサポートする派生ダイアログは、このメソッドをオーバーライドする必要があります。 既定では、このメソッドはダイアログが完了したことを通知し、返します。

DialogContext は、ダイアログを再開するときにこのメソッドを呼び出します。 スタック上の前のダイアログで値が返された場合、その値は result パラメーターにあります。

子 ダイアログを開始するには、DialogContext.beginDialog または DialogContext.prompt使用します。ただし、このダイアログは必ずしも子ダイアログを開始したダイアログであるとは限りません。 このダイアログが完了したことをダイアログ コンテキストに通知するには、このメソッドを終了する前に DialogContext.endDialog 待機します。

も参照

• DialogContext.endDialog

Dialog.resumeDialog から継承された