ActionContext class

ActionContext クラスの新しいインスタンスを初期化します。

new ActionContext(dialogs: DialogSet, parentDialogContext: DialogContext, state: DialogState, actions: ActionState[], changeKey: symbol)

パラメーター

実行中のアクションの一覧。

actions: ActionState[]

プロパティ値

適用するキューに登録されている変更の一覧を取得します。

ActionChangeList[] changes

プロパティ値

キューに入った変更の一覧。

activeDialog: DialogInstance | undefined

プロパティ値

DialogContext.activeDialog から継承された

child: DialogContext | undefined

プロパティ値

DialogContext.child から継承された

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

context: TurnContext

プロパティ値

DialogContext.context から継承された

dialogManager: DialogManager

プロパティ値

DialogContext.dialogManager から継承された

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

dialogs: DialogSet

プロパティ値

DialogContext.dialogs から継承された

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

parent: DialogContext | undefined

プロパティ値

注釈

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

DialogContext.parent から継承された

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

services: TurnContextStateCollection

プロパティ値

DialogContext.services から継承された

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

stack: DialogInstance[]

プロパティ値

DialogContext.stack から継承された

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

state: DialogStateManager

プロパティ値

DialogContext.state から継承された

キューに登録された変更を適用します。

function applyChanges(): Promise<boolean>

戻り値

適用する変更があった場合は True。

applyChanges() が呼び出されたときに適用される一連の変更をキューに登録します。

function queueChanges(changes: ActionChangeList)

パラメーター

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

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

パラメーター

戻り値

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

注釈

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

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

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

例えば：

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

も参照

• endDialog を する
• プロンプト
• replaceDialog
• Dialog.beginDialog

DialogContext.beginDialog から継承された

ダイアログ スタック上のすべてのダイアログをキャンセルし、スタックをクリアします。

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

パラメーター

戻り値

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

注釈

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

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

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

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

も参照

• endDialog を する

DialogContext.cancelAllDialogs から継承された

アクティブなダイアログがある場合は、このダイアログ コンテキストを 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.`);
}

DialogContext.continueDialog から継承された

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

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

パラメーター

戻り値

イベントが処理されたかどうかを true します。

注釈

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

DialogContext.emitEvent から継承された

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

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

パラメーター

戻り値

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

注釈

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

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

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

例えば：

return await dc.endDialog(returnValue);

も参照

• beginDialog を する
• replaceDialog
• Dialog.endDialog

DialogContext.endDialog から継承された

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

function findDialog(dialogId: string): Dialog | undefined

パラメーター

戻り値

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

注釈

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

も参照

• ダイアログ
• 親

DialogContext.findDialog から継承された

DialogContext で CultureInfo を取得します。

function getLocale(): string

戻り値

ロケール文字列。

DialogContext.getLocale から継承された

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

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?`);

DialogContext.prompt から継承された

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

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?`);

DialogContext.prompt から継承された

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

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

パラメーター

戻り値

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

注釈

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

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

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

も参照

• beginDialog を する
• endDialog を する

DialogContext.replaceDialog から継承された

アクティブなダイアログに対して、ユーザーに入力を再度求めるメッセージを表示するように要求します。

function repromptDialog(): Promise<void>

戻り値

注釈

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

例えば：

await dc.repromptDialog();

DialogContext.repromptDialog から継承された