Dialog class

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

new Dialog(dialogId?: string)

パラメーター

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

static EndOfTurn: DialogTurnResult

プロパティ値

注釈

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

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

string id

プロパティ値

ダイアログの ID。

注釈

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

このダイアログのテレメトリ クライアントを取得します。 このダイアログのテレメトリ クライアントを設定します。

BotTelemetryClient telemetryClient

プロパティ値

ログ記録に使用する BotTelemetryClient。

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

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

パラメーター

戻り値

注釈

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

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

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

も参照

• DialogContext.beginDialog
• DialogContext.replaceDialog

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

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

パラメーター

戻り値

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

注釈

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

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

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

も参照

• DialogContext.continueDialog

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

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

パラメーター

戻り値

注釈

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

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

も参照

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

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

function getVersion(): string

戻り値

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

注釈

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

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

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

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

パラメーター

戻り値

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

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

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

パラメーター

戻り値

注釈

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

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

も参照

• DialogContext.repromptDialog
• プロンプト

派生クラスでオーバーライドされると、スタック上のダイアログが完了した後にダイアログを再開します。

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

パラメーター

戻り値

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

注釈

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

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

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

も参照

• DialogContext.endDialog

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

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

パラメーター

戻り値

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

継承構成可能。構成

function getConverter(_property: string): Converter | ConverterFactory

パラメーター

戻り値

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

継承元構成可能な.getConverter