Prompt class

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

string id

プロパティ値

ダイアログの ID。

注釈

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

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

BotTelemetryClient telemetryClient

プロパティ値

ログ記録に使用する BotTelemetryClient 。

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

static EndOfTurn: DialogTurnResult

プロパティ値

注釈

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

Dialog.EndOfTurnから継承

プロンプト ダイアログがダイアログ スタックにプッシュされ、アクティブ化されるときに呼び出されます。

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

パラメーター

戻り値

非同期操作を表す Promise。

注釈

タスクが成功した場合、結果は、プロンプトによってターンが処理された後もプロンプトがまだアクティブかどうかを示します。

プロンプト ダイアログがアクティブなダイアログで、ユーザーが新しいアクティビティで応答したときに呼び出されます。

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

パラメーター

戻り値

非同期操作を表す Promise。

注釈

タスクが成功した場合、結果は、ダイアログによってターンが処理された後もダイアログがアクティブかどうかを示します。 通常、プロンプトは、ユーザーの応答をプロンプトの有効な入力として受け入れるまで、ユーザーの応答を受け取り続けます。

入力を求めるプロンプト ダイアログがユーザーに要求されたときに呼び出されます。

function repromptDialog(context: TurnContext, instance: DialogInstance): Promise<void>

パラメーター

戻り値

非同期操作を表す Promise。

ダイアログ ダイアログがダイアログ スタックのアクティブなダイアログとして再開されるときに呼び出されます。たとえば、スタック上の以前のアクティブなダイアログが完了したときなどです。

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

パラメーター

戻り値

非同期操作を表す Promise。

注釈

タスクが成功した場合、結果は、ダイアログによってターンが処理された後もダイアログがアクティブかどうかを示します。

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

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

パラメーター

戻り値

操作の完了後に 構成可能 。

継承元構成可能.configure

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

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

パラメーター

戻り値

注釈

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

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

参照

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

Dialog.endDialogから継承

function getConverter(_property: string): Converter | ConverterFactory

パラメーター

戻り値

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

Configure.getConverterから継承

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

function getVersion(): string

戻り値

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

注釈

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

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

Dialog.getVersionから継承

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

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

パラメーター

戻り値

現在のダイアログでイベントが処理され、バブリングが停止する場合は True です。

Dialog.onDialogEventから継承