DialogContext class

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

new DialogContext(dialogs: DialogSet, contextOrDC: DialogContext, state: DialogState)

パラメーター

注釈

DialogContext インスタンスを渡すと、ダイアログ コンテキストが複製されます。

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

new DialogContext(dialogs: DialogSet, contextOrDC: TurnContext, state: DialogState)

パラメーター

注釈

DialogContext インスタンスを渡すと、ダイアログ コンテキストが複製されます。

DialogInstance | undefined activeDialog

プロパティ値

ダイアログ スタックの上部にあるダイアログの状態情報。スタック undefined が空の場合は 。

DialogContext | undefined child

プロパティ値

アクティブなダイアログがコンテナーである場合の子のダイアログ コンテキスト。

ターンのコンテキスト オブジェクトを取得します。

context: TurnContext

プロパティ値

DialogManager dialogManager

プロパティ値

現在のダイアログ マネージャー インスタンス。 このプロパティの使用は非推奨とされます。

このコンテキストから直接呼び出すことができるダイアログを取得します。

dialogs: DialogSet

プロパティ値

このダイアログ コンテキストの親ダイアログ コンテキスト。この undefined コンテキストに親がない場合は 。

parent: DialogContext | undefined

プロパティ値

注釈

ダイアログを開始しようとすると、ダイアログ コンテキストはダイアログ内の Dialog.id を検索 します。 このダイアログ コンテキストで開始するダイアログが見つからない場合は、その親ダイアログ コンテキストで検索が行われます。

このダイアログ コンテキストに依存するサービス コレクションを取得します。

services: TurnContextStateCollection

プロパティ値

現在のダイアログ スタックを取得します。

stack: DialogInstance[]

プロパティ値

すべてのメモリ スコープのビューを管理する DialogStateManager を取得します。

state: DialogStateManager

プロパティ値

ダイアログ インスタンスを開始し、ダイアログ スタックにプッシュします。 ダイアログの新しいインスタンスを作成し、スタックにプッシュします。

function beginDialog(dialogId: string, options?: object): Promise<DialogTurnResult>

パラメーター

戻り値

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

注釈

スタックに既にアクティブなダイアログがある場合、そのダイアログはスタック上の上部のダイアログに戻るまで一時停止されます。

返されるオブジェクトの 状態 は、このメソッドが完了した後のダイアログ スタックの状態を表します。

要求されたダイアログがこのダイアログ コンテキストまたはその先祖のいずれにも見つからない場合、このメソッドは例外をスローします。

以下に例を示します。

const result = await dc.beginDialog('greeting', { name: user.name });

参照

• Enddialog
• prompt
• replaceDialog
• Dialog.beginDialog

ダイアログ スタック上のすべてのダイアログを取り消し、スタックをクリアします。

function cancelAllDialogs(cancelParents?: boolean, eventName?: string, eventValue?: any): Promise<DialogTurnResult>

パラメーター

戻り値

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

注釈

これにより、スタックからダイアログを削除する前に、各ダイアログの Dialog.endDialog メソッドが呼び出されます。

スタックに最初にダイアログがあった場合、戻り値の 状態 は 取り消されます。それ以外の場合は 空です。

次の使用例は、 dc'bookFlight' ダイアログを開始する前にダイアログ スタックをクリアします。

await dc.cancelAllDialogs();
return await dc.beginDialog('bookFlight');

参照

• Enddialog

アクティブなダイアログがある場合は、このダイアログ コンテキストを Dialog.continueDialog メソッドに渡して、実行を続行します。

function continueDialog(): Promise<DialogTurnResult>

戻り値

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

注釈

呼び出しが完了したら、ターン コンテキストの 応答 プロパティを確認して、ダイアログがユーザーに返信を送信したかどうかを判断できます。

返されるオブジェクトの 状態 は、このメソッドが完了した後のダイアログ スタックの状態を表します。

通常は、ボットのターン ハンドラー内からこれを呼び出します。

以下に例を示します。

const result = await dc.continueDialog();
if (result.status == DialogTurnStatus.empty && dc.context.activity.type == ActivityTypes.message) {
    // Send fallback message
    await dc.context.sendActivity(`I'm sorry. I didn't understand.`);
}

指定された ID を持つダイアログを検索します。

function emitEvent(name: string, value?: any, bubble?: boolean, fromLeaf?: boolean): Promise<boolean>

パラメーター

戻り値

true イベントが処理された場合は 。

注釈

現在のダイアログまたはそれを開始したユーザーが処理する名前付きイベントを生成します。

ダイアログを終了し、スタックからポップします。 ダイアログの親にオプションの結果を返します。

function endDialog(result?: any): Promise<DialogTurnResult>

パラメーター

戻り値

ダイアログ ターンの結果に対する promise 解決。

注釈

親ダイアログは、ダイアログ スタック上の次のダイアログ (存在する場合) です。 このメソッドは、親の Dialog.resumeDialog メソッドを呼び出し、終了ダイアログによって返される結果を渡します。 親ダイアログがない場合、ターンは終了し、返されたオブジェクトの result プロパティを使用してボットで 結果 を使用できます。

返されるオブジェクトの 状態 は、このメソッドが完了した後のダイアログ スタックの状態を表します。

通常は、特定のダイアログのロジック内からこれを呼び出して、ダイアログが完了したことをダイアログ コンテキストに通知し、ダイアログをスタックから削除し、親ダイアログを再開します。

以下に例を示します。

return await dc.endDialog(returnValue);

参照

• beginDialog
• replaceDialog
• Dialog.endDialog

特定の ID を持つダイアログを検索します。

function findDialog(dialogId: string): Dialog | undefined

パラメーター

戻り値

指定された ID のダイアログ。

注釈

このダイアログ コンテキストに関連付けられている DialogSet で開始するダイアログが見つからない場合は、親ダイアログ コンテキストでダイアログを検索しようとします。

参照

• ダイアログ
• parent

DialogContext で CultureInfo を取得します。

function getLocale(): string

戻り値

ロケール文字列。

プロンプト ダイアログを呼び出すためのオプションの書式設定を簡略化するヘルパー関数。

function prompt(dialogId: string, promptOrOptions: string | Partial<Activity> | PromptOptions): Promise<DialogTurnResult>

パラメーター

戻り値

注釈

このヘルパー メソッドは、 パラメーターとして使用するオブジェクトを options 書式設定し、 beginDialog を呼び出して、指定したプロンプト ダイアログを開始します。

return await dc.prompt('confirmPrompt', `Are you sure you'd like to quit?`);

プロンプト ダイアログを呼び出すためのオプションの書式設定を簡略化するヘルパー関数。

function prompt(dialogId: string, promptOrOptions: string | Partial<Activity> | PromptOptions, choices: string | Choice[]): Promise<DialogTurnResult>

パラメーター

戻り値

注釈

このヘルパー メソッドは、 パラメーターとして使用するオブジェクトを options 書式設定し、 beginDialog を呼び出して、指定したプロンプト ダイアログを開始します。

return await dc.prompt('confirmPrompt', `Are you sure you'd like to quit?`);

アクティブなダイアログを終了し、その代わりに新しいダイアログを開始します。

function replaceDialog(dialogId: string, options?: object): Promise<DialogTurnResult>

パラメーター

戻り値

ダイアログ ターンの結果に対する promise 解決。

注釈

これは、ループを作成したり、別のダイアログにリダイレクトしたりする場合に特に便利です。

返されるオブジェクトの 状態 は、このメソッドが完了した後のダイアログ スタックの状態を表します。

このメソッドは、現在のダイアログを終了し、新しいダイアログをすぐに開始するのと似ています。 ただし、親ダイアログは再開も通知もされません。

参照

• beginDialog
• Enddialog

アクティブなダイアログを要求して、ユーザーに入力を再度求めます。

function repromptDialog(): Promise<void>

戻り値

注釈

これにより、アクティブなダイアログの repromptDialog メソッドが呼び出されます。

以下に例を示します。

await dc.repromptDialog();