BeginDialog class

パッケージ:

botbuilder-dialogs-adaptive

別の ダイアログの実行を開始するアクション。完了すると、呼び出し元に戻ります。

Extends

BaseInvokeDialog<O>

コンストラクター

BeginDialog(string, O)

新しい BeginDialog インスタンスを作成します。

プロパティ

$kind
disabled	true の場合は、このアクションを無効にする省略可能な式。
resultProperty	(省略可能) ダイアログの結果を格納するプロパティ パス。

継承されたプロパティ

activityProcessed	新しいダイアログでアクティビティを処理するかどうかを示す値。
dialog	呼び出すダイアログ。
EndOfTurn	既定のターン終了の結果を取得します。
id
options	ダイアログの構成可能なオプション。
telemetryClient

メソッド

beginDialog(DialogContext, O)	ダイアログ が開始され、ダイアログ スタックにプッシュされたときに呼び出されます。
getConverter(Object)
resumeDialog(DialogContext, DialogReason, any)	子 ダイアログ ターンが完了し、このダイアログに制御が返されたときに呼び出されます。

継承されたメソッド

configure(Record<string, unknown>)	オブジェクトを構成するための Fluent メソッド。
continueDialog(DialogContext)	派生クラスでオーバーライドされた場合は、ダイアログを続行します。
endDialog(TurnContext, DialogInstance, DialogReason)	派生クラスでオーバーライドされると、ダイアログが終了する前にクリーンアップを実行します。
getDependencies()	子 ダイアログ 依存関係を取得し、ダイアログ セット コンテナーに追加できるようにします。
getVersion()	再デプロイ時のボットの変更の検出に役立つエンコードされた文字列。
onDialogEvent(DialogContext, DialogEvent)	現在のダイアログまたは現在のダイアログが開始したダイアログによって、DialogContext.emitEvent()を使用してイベントが発生したときに呼び出されます。
repromptDialog(TurnContext, DialogInstance)	派生クラスでオーバーライドされると、ユーザーに入力を要求します。

コンストラクターの詳細

BeginDialog(string, O)

新しい BeginDialog インスタンスを作成します。

new BeginDialog(dialogIdToCall: string, options?: O)

パラメーター

dialogIdToCall

string

呼び出すダイアログの ID。

options

O

(省略可能) 呼び出されたダイアログを渡す静的オプション。

プロパティの詳細

$kind

static $kind: string

プロパティ値

string

disabled

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

disabled?: BoolExpression

プロパティ値

BoolExpression

resultProperty

(省略可能) ダイアログの結果を格納するプロパティ パス。

resultProperty?: StringExpression

プロパティ値

StringExpression

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

activityProcessed

新しいダイアログでアクティビティを処理するかどうかを示す値。

activityProcessed: BoolExpression

プロパティ値

BoolExpression

BaseInvokeDialog.activityProcessed から継承された

dialog

呼び出すダイアログ。

dialog: DialogExpression

プロパティ値

DialogExpression

baseInvokeDialog.dialog から継承

EndOfTurn

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

static EndOfTurn: DialogTurnResult

プロパティ値

DialogTurnResult

注釈

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

Dialog.EndOfTurn から継承された

id

id: string

プロパティ値

string

Dialog.id から継承された

options

ダイアログの構成可能なオプション。

options: ObjectExpression<object>

プロパティ値

ObjectExpression<object>

baseInvokeDialog.optionsから継承された

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

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

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。

継承済みメソッドの詳細

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

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

戻り値

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

getDependencies()

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

function getDependencies(): Dialog<__type>[]

戻り値

Dialog<__type>[]

子 ダイアログ 依存関係。

baseInvokeDialog.getDependencies から継承

getVersion()

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

function getVersion(): string

戻り値

string

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

注釈

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

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

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

も参照

• DialogContext.repromptDialog
• プロンプト

Dialog.repromptDialog から継承された