EndDialog class
現在のダイアログを終了するコマンド。 ダイアログの結果として を返 resultProperty します。
- Extends
-
Dialog<O>
コンストラクター
| End |
新しい |
プロパティ
| $kind | |
| disabled | が true の場合、このアクションを無効にする省略可能な式。 |
| value | 呼び出し元に返される結果の値式。 |
継承されたプロパティ
| End |
既定のターン終了の結果を取得します。 |
| id | |
| telemetry |
メソッド
| begin |
新しい ダイアログ を開始し、ダイアログ スタックにプッシュします。 |
| get |
継承されたメソッド
| configure(Record<string, unknown>) | オブジェクトを構成するための Fluent メソッド。 |
| continue |
派生クラスでオーバーライドされると、ダイアログを続行します。 |
| end |
派生クラスでオーバーライドされると、ダイアログが終了する前にクリーンアップが実行されます。 |
| get |
再デプロイ時のボットの変更の検出に役立つエンコードされた文字列。 |
| on |
現在のダイアログまたは現在のダイアログが開始したダイアログによって、 を使用して |
| reprompt |
派生クラスでオーバーライドされると、ユーザーに入力を要求します。 |
| resume |
派生クラスでオーバーライドされると、スタック上のダイアログが完了した後でダイアログを再開します。 |
コンストラクターの詳細
EndDialog(any)
新しい EndDialog のインスタンスを作成します。
new EndDialog(value?: any)パラメーター
- value
-
any
省略可能。呼び出し元に返される結果の値式。
プロパティの詳細
$kind
static $kind: stringプロパティ値
string
disabled
が true の場合、このアクションを無効にする省略可能な式。
disabled?: BoolExpressionプロパティ値
BoolExpression
value
呼び出し元に返される結果の値式。
value: ValueExpressionプロパティ値
ValueExpression
継承されたプロパティの詳細
EndOfTurn
既定のターン終了の結果を取得します。
static EndOfTurn: DialogTurnResultプロパティ値
DialogTurnResult
注釈
この結果は、ダイアログ (またはダイアログ内の論理ステップ) が現在のターンの処理を完了し、まだアクティブであり、より多くの入力を待機していることを示します。
継承元 Dialog.EndOfTurn
id
id: stringプロパティ値
string
Dialog.id から継承
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
セレクター構成のコンバーター。
継承済みメソッドの詳細
configure(Record<string, unknown>)
オブジェクトを構成するための Fluent メソッド。
function configure(config: Record<string, unknown>): thisパラメーター
- config
-
Record<string, unknown>
適用する構成設定。
戻り値
this
操作の完了後に 構成可能 。
継承元 Configure.configure
continueDialog(DialogContext)
派生クラスでオーバーライドされると、ダイアログを続行します。
function continueDialog(dc: DialogContext): Promise<DialogTurnResult>パラメーター
- dc
-
DialogContext
現在のダイアログ ターンのコンテキスト。
戻り値
Promise<DialogTurnResult>
ダイアログ ターンの結果を解決する Promise。
注釈
複数ターンの会話をサポートする派生ダイアログでは、このメソッドをオーバーライドする必要があります。 既定では、このメソッドはダイアログが完了したことを通知し、 を返します。
DialogContext は、ダイアログを続行するときにこのメソッドを呼び出します。
このダイアログが完了したことをダイアログ コンテキストに通知するには、このメソッドを終了する前に DialogContext.endDialog を待機します。
参照
継承元 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 は、現在のダイアログが終了するときにこのメソッドを呼び出します。
参照
継承元 Dialog.endDialog
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 は、現在のダイアログでユーザーからの入力を要求する必要がある場合に、このメソッドを呼び出します。 このメソッドは、プロンプト ダイアログ用に実装されます。
参照
継承元 Dialog.repromptDialog
resumeDialog(DialogContext, DialogReason, any)
派生クラスでオーバーライドされると、スタック上のダイアログが完了した後でダイアログを再開します。
function resumeDialog(dc: DialogContext, reason: DialogReason, result?: any): Promise<DialogTurnResult>パラメーター
- dc
-
DialogContext
現在のダイアログ ターンのコンテキスト。
- reason
-
DialogReason
ダイアログが再開される理由。 これは通常、DialogReason.endCalled になります
- result
-
any
省略可能。 終了したダイアログからの戻り値 (存在する場合)。
戻り値
Promise<DialogTurnResult>
ダイアログ ターンの結果を解決する Promise。
注釈
複数ターンの会話をサポートする派生ダイアログでは、このメソッドをオーバーライドする必要があります。 既定では、このメソッドはダイアログが完了したことを通知し、 を返します。
DialogContext は、ダイアログを再開するときにこのメソッドを呼び出します。 スタック上の前のダイアログで値が返された場合、その値は パラメーター内 result にあります。
子ダイアログを開始するには、DialogContext.beginDialog または DialogContext.prompt を使用します。ただし、このダイアログは必ずしも子ダイアログを開始したダイアログではありません。 このダイアログが完了したことをダイアログ コンテキストに通知するには、このメソッドを終了する前に DialogContext.endDialog を待機します。
参照
継承元 Dialog.resumeDialog