BeginSkill class
スキルを開始します。
- Extends
-
SkillDialog
コンストラクター
| Begin |
新しい 'BeginSkillDialog インスタンスを作成します。 |
プロパティ
| $kind | |
| activity | アクティビティのテンプレート。 |
| activity |
新しいダイアログでアクティビティを処理するかどうかを示す値。 |
| allow |
割り込みポリシー。 |
| bot |
スキルを呼び出す Microsoft アプリ ID。 |
| connection |
随意。 親ボットの OAuth 接続名。 |
| disabled | true の場合、このアクションを無効にする省略可能な式。 |
| result |
ダイアログの結果を格納する省略可能なプロパティ パス。 |
| skill |
スキルの Microsoft アプリ ID。 |
| skill |
スキルの |
| skill |
スキル ホストのコールバック URL。 |
継承されたプロパティ
| End |
既定のターン終了の結果を取得します。 |
| id | |
| telemetry |
メソッド
| begin |
ダイアログ が開始され、ダイアログ スタックにプッシュされたときに呼び出されます。 |
| continue |
|
| end |
ダイアログ の終了時に呼び出されます。 |
| get |
|
| reprompt |
ダイアログ がユーザーに入力を再度求める必要があるときに呼び出されます。 |
| resume |
子 ダイアログ ターンが完了し、このダイアログに制御が返されたときに呼び出されます。 |
継承されたメソッド
| configure(Record<string, unknown>) | オブジェクトを構成するための Fluent メソッド。 |
| get |
再デプロイ時のボットの変更の検出に役立つエンコードされた文字列。 |
| on |
現在のダイアログまたは現在のダイアログが開始したダイアログによって、 |
コンストラクターの詳細
BeginSkill(SkillDialogOptions)
新しい 'BeginSkillDialog インスタンスを作成します。
new BeginSkill(options?: SkillDialogOptions)
パラメーター
- options
-
SkillDialogOptions
スキル ダイアログの構成に使用するオプション (省略可能)。
プロパティの詳細
$kind
static $kind: string
プロパティ値
string
activity
アクティビティのテンプレート。
activity: TemplateInterface<Partial<Activity>, DialogStateManager>
プロパティ値
TemplateInterface<Partial<Activity>, DialogStateManager>
activityProcessed
新しいダイアログでアクティビティを処理するかどうかを示す値。
activityProcessed: BoolExpression
プロパティ値
BoolExpression
注釈
この既定値は true になります。つまり、新しいダイアログではアクティビティを確認できません。 これを false に設定すると、アクティビティを新しいダイアログにディスパッチできます。
allowInterruptions
割り込みポリシー。
allowInterruptions: BoolExpression
プロパティ値
BoolExpression
botId
スキルを呼び出す Microsoft アプリ ID。
botId: StringExpression
プロパティ値
StringExpression
注釈
設定からボット ID を取得する =settings.MicrosoftAppId の値に遅延します。
connectionName
随意。 親ボットの OAuth 接続名。
connectionName: StringExpression
プロパティ値
StringExpression
disabled
true の場合、このアクションを無効にする省略可能な式。
disabled?: BoolExpression
プロパティ値
BoolExpression
resultProperty
ダイアログの結果を格納する省略可能なプロパティ パス。
resultProperty?: StringExpression
プロパティ値
StringExpression
skillAppId
スキルの Microsoft アプリ ID。
skillAppId: StringExpression
プロパティ値
StringExpression
skillEndpoint
スキルの /api/messages エンドポイント。
skillEndpoint: StringExpression
プロパティ値
StringExpression
skillHostEndpoint
スキル ホストのコールバック URL。
skillHostEndpoint: StringExpression
プロパティ値
StringExpression
注釈
設定からエンドポイントを取得する =settings.SkillHostEndpoint の値に遅延します。
継承されたプロパティの詳細
EndOfTurn
既定のターン終了の結果を取得します。
static EndOfTurn: DialogTurnResult
プロパティ値
DialogTurnResult
注釈
この結果は、ダイアログ (またはダイアログ内の論理ステップ) が現在のターンの処理を完了し、まだアクティブであり、より多くの入力を待機していることを示します。
Dialog.EndOfTurn から継承された
id
id: string
プロパティ値
string
Dialog.id から継承された
telemetryClient
telemetryClient: BotTelemetryClient
プロパティ値
BotTelemetryClient
Dialog.telemetryClient から継承された
メソッドの詳細
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(turnContext: TurnContext, instance: DialogInstance, reason: DialogReason): Promise<void>
パラメーター
- turnContext
-
TurnContext
(xref:botbuilder-core。TurnContext)、このターンのコンテキスト オブジェクト。
- instance
-
DialogInstance
(xref:botbuilder-dialogs。DialogInstance)、ダイアログ スタック上のこのダイアログのインスタンスに関連付けられている状態情報。
- reason
-
DialogReason
(xref:botbuilder-dialogs。DialogReason)、ダイアログが終了した理由。
戻り値
Promise<void>
非同期操作を表す Promise。
getConverter(Object)
function getConverter(property: Object): Converter | ConverterFactory
パラメーター
- property
-
Object
条件付きセレクター構成のキー。
戻り値
Converter | ConverterFactory
セレクター構成のコンバーター。
repromptDialog(TurnContext, DialogInstance)
ダイアログ がユーザーに入力を再度求める必要があるときに呼び出されます。
function repromptDialog(turnContext: TurnContext, instance: DialogInstance): Promise<void>
パラメーター
- turnContext
-
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<any>>
パラメーター
- dc
-
DialogContext
会話の現在のターンの DialogContext。
- reason
-
DialogReason
(xref:botbuilder-dialogs。DialogReason)、ダイアログが再開された理由。
- result
-
any
随意。 呼び出されたダイアログから返される値。 返される値の型は、子ダイアログに依存します。
戻り値
Promise<DialogTurnResult<any>>
非同期操作を表す Promise。
継承済みメソッドの詳細
configure(Record<string, unknown>)
オブジェクトを構成するための Fluent メソッド。
function configure(config: Record<string, unknown>): this
パラメーター
- config
-
Record<string, unknown>
適用する構成設定。
戻り値
this
操作が完了した後の 構成可能な。
継承 構成可能。configure
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 から継承された