ConfirmPrompt class

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

new ConfirmPrompt(dialogId: string, validator?: PromptValidator<boolean>, defaultLocale?: string, choiceDefaults?: ChoiceDefaultsConfirmPrompt)

パラメーター

ChoiceFactory に渡され、ユーザーに表示される選択肢のスタイルを調整するために使用される追加のオプション。

choiceOptions: ChoiceFactoryOptions | undefined

プロパティ値

プロンプトに対して送信する選択肢のカスタム リスト。

confirmChoices: string | Choice[] | undefined

プロパティ値

認識する必要がある既定のロケールを確認します。

defaultLocale: string | undefined

プロパティ値

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

string id

プロパティ値

ダイアログの ID。

注釈

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

プロンプト時にユーザーに表示される "はい" と "いいえ" の選択肢のスタイル。

style: ListStyle

プロパティ値

注釈

既定値は ListStyle.autoです。

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

BotTelemetryClient telemetryClient

プロパティ値

ログ記録に使用する BotTelemetryClient。

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

static EndOfTurn: DialogTurnResult

プロパティ値

注釈

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

Dialog.EndOfTurn から継承された

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

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

パラメーター

戻り値

非同期操作を表す Promise。

注釈

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

Prompt.beginDialog から継承された

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

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

パラメーター

戻り値

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

継承構成可能。構成

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

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

パラメーター

戻り値

非同期操作を表す Promise。

注釈

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

Prompt.continueDialog から継承された

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

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

パラメーター

戻り値

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

継承元構成可能な.getConverter

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

function getVersion(): string

戻り値

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

注釈

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

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

Dialog.getVersion から継承された

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

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

パラメーター

戻り値

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

Dialog.onDialogEvent から継承された

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

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

パラメーター

戻り値

非同期操作を表す Promise。

Prompt.repromptDialog から継承された

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

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

パラメーター

戻り値

非同期操作を表す Promise。

注釈

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

Prompt.resumeDialog から継承された