次の方法で共有

SkillDialog class

  • リファレンス
パッケージ:
botbuilder-dialogs

スキルへのリモート呼び出しをラップできる特殊なダイアログ。

Extends

Dialog<Partial<BeginSkillDialogOptions>>

注釈

beginDialog の options パラメーターは、ダイアログの初期パラメーターを持つ BeginSkillDialogOptions インスタンスである必要があります。

コンストラクター

SkillDialog(SkillDialogOptions, string)

スキルへのリモート呼び出しをラップできるサンプル ダイアログ。

プロパティ

id

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

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

継承されたプロパティ

EndOfTurn

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

メソッド

beginDialog(DialogContext, BeginSkillDialogOptions)

スキル ダイアログが開始され、ダイアログ スタックにプッシュされたときに呼び出されます。
continueDialog(DialogContext)

スキル ダイアログが 継続場合に呼び出されます。アクティブなダイアログであり、ユーザーは新しい アクティビティで応答します。
endDialog(TurnContext, DialogInstance, DialogReason)

スキル ダイアログが終了するときに呼び出されます。
repromptDialog(TurnContext, DialogInstance)

スキル ダイアログがユーザーに入力を再度求める必要があるときに呼び出されます。
resumeDialog(DialogContext, DialogReason, any)

子スキル ダイアログがターンを完了し、このダイアログに制御を返したときに呼び出されます。

継承されたメソッド

configure(Record<string, unknown>)

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

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

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

コンストラクターの詳細

SkillDialog(SkillDialogOptions, string)

スキルへのリモート呼び出しをラップできるサンプル ダイアログ。

new SkillDialog(dialogOptions: SkillDialogOptions, dialogId?: string)

パラメーター

dialogOptions
SkillDialogOptions

スキル ダイアログを実行するためのオプション。

dialogId

string

ダイアログの ID。

注釈

beginDialog() の options パラメーターは、ダイアログの初期パラメーターを持つ SkillDialogArgs オブジェクトである必要があります。

プロパティの詳細

id

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

string id

プロパティ値

string

ダイアログの ID。

注釈

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

telemetryClient

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

BotTelemetryClient telemetryClient

プロパティ値

BotTelemetryClient

ログ記録に使用する BotTelemetryClient。

継承されたプロパティの詳細

EndOfTurn

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

static EndOfTurn: DialogTurnResult

プロパティ値

DialogTurnResult

注釈

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

Dialog.EndOfTurn から継承された

メソッドの詳細

beginDialog(DialogContext, BeginSkillDialogOptions)

スキル ダイアログが開始され、ダイアログ スタックにプッシュされたときに呼び出されます。

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

パラメーター

dc
DialogContext

会話の現在のターンの DialogContext。

options
BeginSkillDialogOptions

ダイアログに渡す初期情報。

戻り値

Promise<DialogTurnResult>

非同期操作を表す Promise。

注釈

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

continueDialog(DialogContext)

スキル ダイアログが 継続場合に呼び出されます。アクティブなダイアログであり、ユーザーは新しい アクティビティで応答します。

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

パラメーター

dc
DialogContext

会話の現在のターンの DialogContext。

戻り値

Promise<DialogTurnResult>

非同期操作を表す Promise。

注釈

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

endDialog(TurnContext, DialogInstance, DialogReason)

スキル ダイアログが終了するときに呼び出されます。

function endDialog(context: TurnContext, instance: DialogInstance, reason: DialogReason): Promise<void>

パラメーター

context

TurnContext

このターンの TurnContext オブジェクト。

instance
DialogInstance

ダイアログ スタック上のこのダイアログのインスタンスに関連付けられている状態情報。

reason
DialogReason

(xref:botbuilder-dialogs。DialogReason) ダイアログが終了した理由。

戻り値

Promise<void>

非同期操作を表す Promise。

repromptDialog(TurnContext, DialogInstance)

スキル ダイアログがユーザーに入力を再度求める必要があるときに呼び出されます。

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

パラメーター

context

TurnContext

このターンの TurnContext オブジェクト。

instance
DialogInstance

このダイアログの状態情報。

戻り値

Promise<void>

非同期操作を表す Promise。

resumeDialog(DialogContext, DialogReason, any)

子スキル ダイアログがターンを完了し、このダイアログに制御を返したときに呼び出されます。

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

パラメーター

dc
DialogContext

会話の現在のターンの DialogContext。

_reason
DialogReason

(xref:botbuilder-dialogs。DialogReason) ダイアログが再開された理由。

_result

any

オプション。呼び出されたダイアログから返される値。 返される値の型は、子ダイアログに依存します。

戻り値

Promise<DialogTurnResult>

非同期操作を表す Promise。

継承済みメソッドの詳細

configure(Record<string, unknown>)

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

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

パラメーター

config

Record<string, unknown>

適用する構成設定。

戻り値

this

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

継承構成可能。構成

getConverter(string) 

function getConverter(_property: string): Converter | ConverterFactory

パラメーター

_property

string

条件付きセレクター構成のキー。

戻り値

Converter | ConverterFactory

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

継承元構成可能な.getConverter

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 から継承された