ComponentDialog クラス

リファレンス

他のダイアログで構成される Dialog

ComponentDialog の新しいインスタンスを初期化します。

コンストラクター

ComponentDialog(dialog_id: str)

パラメーター

名前	説明
dialog_id 必須	str 親ダイアログセット内の新しいダイアログに割り当てる ID。

変数

名前	説明
state	<xref:persisted_dialog>

メソッド

add_dialog	コンポーネントダイアログに <xref:botbuilder.dialogs.component_dialog.Dialog> を追加し、更新されたコンポーネントを返します。
begin_dialog	ダイアログが開始され、親のダイアログスタックにプッシュされたときに呼び出されます。タスクが成功した場合、結果は、ダイアログによってターンが処理された後もダイアログがアクティブかどうかを示します。
continue_dialog	ダイアログが続くと呼び出されます。ダイアログはアクティブなダイアログであり、ユーザーは新しいアクティビティで応答します。
end_component	コンポーネントダイアログを親のコンテキストで終了します。
end_dialog	ダイアログが終了するときに呼び出されます。
find_dialog	ID でダイアログを検索します。
on_begin_dialog	ダイアログが開始され、親のダイアログスタックにプッシュされたときに呼び出されます。
on_continue_dialog	ダイアログが続くと呼び出されます。ダイアログはアクティブなダイアログであり、ユーザーは新しいアクティビティで応答します。
on_end_dialog	コンポーネントダイアログを親のコンテキストで終了します。
on_reprompt_dialog
reprompt_dialog	ダイアログがユーザーに入力を再度求める必要があるときに呼び出されます。
resume_dialog	親のダイアログスタック上の子ダイアログがこのターンを完了し、このダイアログコンポーネントに制御を返したときに呼び出されます。

add_dialog

コンポーネントダイアログに <xref:botbuilder.dialogs.component_dialog.Dialog> を追加し、更新されたコンポーネントを返します。

add_dialog(dialog: Dialog) -> object

パラメーター

名前	説明
dialog 必須	追加するダイアログ。

戻り値

型	説明
ComponentDialog	更新された ComponentDialog。

begin_dialog

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

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

async begin_dialog(dialog_context: DialogContext, options: object = None) -> DialogTurnResult

パラメーター

名前	説明
dialog_context 必須	DialogContext 会話の現在のターンの DialogContext。
options	object オプション。ダイアログに渡す初期情報。規定値: None

戻り値

型	説明
end_of_turn	ターンの終了を通知します。

continue_dialog

ダイアログが続くと呼び出されます。ダイアログはアクティブなダイアログであり、ユーザーは新しいアクティビティで応答します。

async continue_dialog(dialog_context: DialogContext) -> DialogTurnResult

パラメーター

名前	説明
dialog_context 必須	DialogContext 会話の現在のターンの親ダイアログコンテキスト。

戻り値

型	説明
end_of_turn	ターンの終了を通知します。

注釈

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

このメソッドがオーバーライドされない場合、コンポーネントダイアログは、その内部ダイアログコンテキストで continue_dialog メソッドを呼び出します。内部ダイアログスタックが空の場合、コンポーネントダイアログは終了し、result が使用可能な場合、コンポーネントダイアログはそれを戻り値として使用します。

end_component

コンポーネントダイアログを親のコンテキストで終了します。

async end_component(outer_dc: DialogContext, result: object) -> DialogTurnResult

パラメーター

名前	説明
outer_dc 必須	現在の会話のターンの親ダイアログコンテキスト。
result 必須	object オプション。ダイアログコンポーネントから親コンテキストに返す値。

戻り値

型	説明
result	返す値。

注釈

タスクが成功した場合、結果は、ターンがダイアログによって処理された後にダイアログが終了したことを示します。

end_dialog

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

async end_dialog(context: TurnContext, instance: DialogInstance, reason: DialogReason) -> None

パラメーター

名前	説明
context 必須	TurnContext このターンのコンテキストオブジェクト。
instance 必須	DialogInstance このコンポーネントダイアログのインスタンスに関連付けられている状態情報。
reason 必須	DialogReason ダイアログが終了した理由。

find_dialog

ID でダイアログを検索します。

async find_dialog(dialog_id: str) -> Dialog

パラメーター

名前	説明
dialog_id 必須	追加するダイアログ。

戻り値

型	説明
Dialog	ダイアログ。ID に一致しない場合は None。

on_begin_dialog

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

async on_begin_dialog(inner_dc: DialogContext, options: object) -> DialogTurnResult

パラメーター

名前	説明
inner_dc 必須	DialogContext 会話の現在のターンの内部ダイアログコンテキスト。
options 必須	object オプション。ダイアログに渡す初期情報。

注釈

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

既定では、コンポーネントダイアログの初期ダイアログの begin_dialog メソッドが呼び出されます。

割り込みロジックを実装するには、派生クラスでこのメソッドをオーバーライドします。

on_continue_dialog

ダイアログが続くと呼び出されます。ダイアログはアクティブなダイアログであり、ユーザーは新しいアクティビティで応答します。

async on_continue_dialog(inner_dc: DialogContext) -> DialogTurnResult

パラメーター

名前	説明
inner_dc 必須	DialogContext 会話の現在のターンの内部ダイアログコンテキスト。

on_end_dialog

コンポーネントダイアログを親のコンテキストで終了します。

async on_end_dialog(context: TurnContext, instance: DialogInstance, reason: DialogReason) -> None

パラメーター

名前	説明
turn_context 必須	TurnContext 会話の現在のターンの TurnContext。
instance 必須	DialogInstance このコンポーネントダイアログの内部ダイアログスタックに関連付けられている状態情報。
reason 必須	DialogReason ダイアログが終了した理由。
context 必須

on_reprompt_dialog

async on_reprompt_dialog(turn_context: TurnContext, instance: DialogInstance) -> None

パラメーター

名前	説明
turn_context 必須	DialogInstance 会話の現在のターンの TurnContext。
instance 必須	DialogInstance このコンポーネントダイアログの内部ダイアログスタックに関連付けられている状態情報。

reprompt_dialog

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

async reprompt_dialog(context: TurnContext, instance: DialogInstance) -> None

パラメーター

名前	説明
context 必須	TurnContext このターンのコンテキストオブジェクト。
instance 必須	DialogInstance このダイアログの状態情報。

resume_dialog

親のダイアログスタック上の子ダイアログがこのターンを完了し、このダイアログコンポーネントに制御を返したときに呼び出されます。

async resume_dialog(dialog_context: DialogContext, reason: DialogReason, result: object = None) -> DialogTurnResult

パラメーター

名前	説明
dialog_context 必須	DialogContext 会話の現在のターンのダイアログコンテキスト。
reason 必須	DialogReason ダイアログが再開された理由。
result	object オプション。呼び出されたダイアログから返される値。規定値: None

戻り値

型	説明
end_of_turn	ターンの終了を通知します。

注釈

コンテナーは通常、スタック上のリーフノードですが、開発者はスタックの上に他のダイアログを自由にプッシュできます。その結果、コンテナーは、プッシュされたダイアログが終了したときに resume_dialog への予期しない呼び出しを受け取ります。コンテナーが途中で終了しないようにするには、このメソッドを実装し、単に内部ダイアログスタックに再プロンプトを求める必要があります。

属性

persisted_dialog_state

persisted_dialog_state = 'dialogs'

フィードバック

このページはお役に立ちましたか?