ConfirmPrompt class
"はい" または "いいえ" の応答で何かを確認するようにユーザーに求めます。
- Extends
-
Prompt<boolean>
注釈
既定では、プロンプトは、ユーザーの選択を表す boolean を呼び出し元のダイアログに戻ります。
コンストラクター
| Confirm |
新しい ConfirmPrompt インスタンスを作成します。 |
プロパティ
| choice |
|
| confirm |
プロンプトに対して送信する選択肢のカスタム リスト。 |
| default |
認識する必要がある既定のロケールを確認します。 |
| id | ダイアログの一意の ID。 ダイアログの一意の ID を設定します。 |
| style | プロンプト時にユーザーに表示される "はい" と "いいえ" の選択肢のスタイル。 |
| telemetry |
このダイアログのテレメトリ クライアントを取得します。 このダイアログのテレメトリ クライアントを設定します。 |
継承されたプロパティ
| End |
既定のターン終了の結果を取得します。 |
継承されたメソッド
| begin |
プロンプト ダイアログがダイアログ スタックにプッシュされ、アクティブ化されるときに呼び出されます。 |
| configure(Record<string, unknown>) | オブジェクトを構成するための Fluent メソッド。 |
| continue |
プロンプト ダイアログがアクティブなダイアログであり、ユーザーが新しいアクティビティで応答したときに呼び出されます。 |
| end |
派生クラスでオーバーライドされると、ダイアログが終了する前にクリーンアップを実行します。 |
| get |
|
| get |
再デプロイ時のボットの変更の検出に役立つエンコードされた文字列。 |
| on |
現在のダイアログまたは現在のダイアログが開始したダイアログによって、 |
| reprompt |
ユーザーに入力を再度求めるプロンプト ダイアログが要求されたときに呼び出されます。 |
| resume |
以前のアクティブなダイアログが完了したときなど、ダイアログ スタック上のアクティブなダイアログとしてプロンプト ダイアログが再開されたときに呼び出されます。 |
コンストラクターの詳細
ConfirmPrompt(string, PromptValidator<boolean>, string, ChoiceDefaultsConfirmPrompt)
新しい ConfirmPrompt インスタンスを作成します。
new ConfirmPrompt(dialogId: string, validator?: PromptValidator<boolean>, defaultLocale?: string, choiceDefaults?: ChoiceDefaultsConfirmPrompt)パラメーター
- dialogId
-
string
親 DialogSet または ComponentDialog内のダイアログの一意の ID。
- validator
-
PromptValidator<boolean>
(省略可能) ユーザーがプロンプトに応答するたびに呼び出される検証コントロール。
- defaultLocale
-
string
(省略可能) TurnContext.activity.locale が指定されていない場合に使用するロケール。 既定値は en-usです。
- choiceDefaults
- ChoiceDefaultsConfirmPrompt
(省略可能)[PromptCultureModels.getSupportedCultures()]] の既定の選択肢のディクショナリをオーバーライドします。
プロパティの詳細
choiceOptions
ChoiceFactory に渡され、ユーザーに表示される選択肢のスタイルを調整するために使用される追加のオプション。
choiceOptions: ChoiceFactoryOptions | undefinedプロパティ値
ChoiceFactoryOptions | undefined
confirmChoices
プロンプトに対して送信する選択肢のカスタム リスト。
confirmChoices: string | Choice[] | undefinedプロパティ値
string | Choice[] | undefined
defaultLocale
認識する必要がある既定のロケールを確認します。
defaultLocale: string | undefinedプロパティ値
string | undefined
id
ダイアログの一意の ID。 ダイアログの一意の ID を設定します。
string idプロパティ値
string
ダイアログの ID。
注釈
これは、指定されていない場合は自動的に生成されます。
style
プロンプト時にユーザーに表示される "はい" と "いいえ" の選択肢のスタイル。
style: ListStyleプロパティ値
注釈
既定値は ListStyle.autoです。
telemetryClient
このダイアログのテレメトリ クライアントを取得します。 このダイアログのテレメトリ クライアントを設定します。
BotTelemetryClient telemetryClientプロパティ値
BotTelemetryClient
ログ記録に使用する BotTelemetryClient。
継承されたプロパティの詳細
EndOfTurn
既定のターン終了の結果を取得します。
static EndOfTurn: DialogTurnResultプロパティ値
注釈
この結果は、ダイアログ (またはダイアログ内の論理ステップ) が現在のターンの処理を完了し、まだアクティブであり、より多くの入力を待機していることを示します。
継承済みメソッドの詳細
beginDialog(DialogContext, PromptOptions)
プロンプト ダイアログがダイアログ スタックにプッシュされ、アクティブ化されるときに呼び出されます。
function beginDialog(dc: DialogContext, options: PromptOptions): Promise<DialogTurnResult>パラメーター
会話の現在のターンの DialogContext。
- options
- PromptOptions
随意。 PromptOptions
戻り値
Promise<DialogTurnResult>
非同期操作を表す Promise。
注釈
タスクが成功した場合、結果は、プロンプトによってターンが処理された後もプロンプトがまだアクティブかどうかを示します。
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>パラメーター
会話の現在のターンの DialogContext。
戻り値
Promise<DialogTurnResult>
非同期操作を表す Promise。
注釈
タスクが成功した場合、結果は、ダイアログによってターンが処理された後もダイアログがアクティブかどうかを示します。 通常、プロンプトは、ユーザーの応答をプロンプトの有効な入力として受け入れるまで、ユーザーの応答を受け取り続けます。
endDialog(TurnContext, DialogInstance, DialogReason)
派生クラスでオーバーライドされると、ダイアログが終了する前にクリーンアップを実行します。
function endDialog(_context: TurnContext, _instance: DialogInstance, _reason: DialogReason): Promise<void>パラメーター
- _context
-
TurnContext
ターンのコンテキスト オブジェクト。
- _instance
- DialogInstance
このダイアログの現在の状態情報。
- _reason
- DialogReason
ダイアログが終了する理由。
戻り値
Promise<void>
注釈
終了する前にログ記録またはクリーンアップを実行する必要がある派生ダイアログは、このメソッドをオーバーライドする必要があります。 既定では、このメソッドは無効です。
DialogContext は、現在のダイアログが終了するときにこのメソッドを呼び出します。
も参照
getConverter(string)
function getConverter(_property: string): Converter | ConverterFactoryパラメーター
- _property
-
string
条件付きセレクター構成のキー。
戻り値
セレクター構成のコンバーター。
getVersion()
再デプロイ時のボットの変更の検出に役立つエンコードされた文字列。
function getVersion(): string戻り値
string
ダイアログを再起動する方法でダイアログが変更された場合にのみ変更する一意の文字列。
注釈
既定では、id versionChanged イベントが発生します。 このイベントがボットによって処理されない場合は、エラーがスローされ、ボットのエラー ハンドラー ロジックが実行されます。
空の文字列を返すと、コンポーネントのバージョン追跡がすべて無効になります。
onDialogEvent(DialogContext, DialogEvent)
現在のダイアログまたは現在のダイアログが開始したダイアログによって、DialogContext.emitEvent()を使用してイベントが発生したときに呼び出されます。
function onDialogEvent(dc: DialogContext, e: DialogEvent): Promise<boolean>パラメーター
会話の現在のターンのダイアログ コンテキスト。
発生しているイベント。
戻り値
Promise<boolean>
True の 場合は、イベントが現在のダイアログで処理され、バブルを停止する必要があります。
repromptDialog(TurnContext, DialogInstance)
ユーザーに入力を再度求めるプロンプト ダイアログが要求されたときに呼び出されます。
function repromptDialog(context: TurnContext, instance: DialogInstance): Promise<void>パラメーター
- context
-
TurnContext
(xref:botbuilder-core。TurnContext)、ユーザーとの会話の現在のターンのコンテキスト。
- instance
- DialogInstance
(xref:botbuilder-dialogs。DialogInstance)、スタック上のダイアログのインスタンス。
戻り値
Promise<void>
非同期操作を表す Promise。
resumeDialog(DialogContext, DialogReason, any)
以前のアクティブなダイアログが完了したときなど、ダイアログ スタック上のアクティブなダイアログとしてプロンプト ダイアログが再開されたときに呼び出されます。
function resumeDialog(dc: DialogContext, _reason: DialogReason, _result?: any): Promise<DialogTurnResult>パラメーター
会話の現在のターンの DialogContext。
- _reason
- DialogReason
ダイアログが再開された理由を示す列挙型。
- _result
-
any
省略可能。スタック上の前のダイアログから返された値。 返される値の型は、前のダイアログに依存します。
戻り値
Promise<DialogTurnResult>
非同期操作を表す Promise。
注釈
タスクが成功した場合、結果は、ダイアログによってターンが処理された後もダイアログがアクティブかどうかを示します。