BotAdapter クラス

  • リファレンス
継承
ABC
BotAdapter

コンストラクター

BotAdapter(on_turn_error: Callable[[TurnContext, Exception], Awaitable] = None)

パラメーター

名前 説明
on_turn_error
既定値: None

メソッド

continue_conversation

プロアクティブ メッセージを会話に送信します。 このメソッドを呼び出して、メッセージを会話に事前に送信します。 ほとんどのチャネルでは、ボットがアクティビティをユーザーに送信する前に、ユーザーがボットとの会話を開始する必要があります。

単一テナントはアダプター (コンソール、テストなど) ですが、マルチテナント対応の BotFrameworkAdapter にとって重要です。 :p aram リファレンス: 続行する会話への参照。 :type reference: ConversationReference :p aram コールバック: 結果のボット ターンに対して呼び出すメソッド。 :type callback: Callable :p aram claims_identity: 会話の 。<xref:botframework.connector.auth.ClaimsIdentity> :type claims_identity: <xref:botframework.connector.auth.ClaimsIdentity> :p aram audience:A 値は、プロアクティブ メッセージの受信者を示します。 :type audience: str
create_conversation

ユーザーとの新しい会話を開始します。 グループのメンバーにメッセージを送信するために使用されます。
delete_activity

既存のアクティビティを削除します。
run_pipeline

アダプター ミドルウェア セットを実行するために親クラスによって呼び出され、チェーンの末尾で渡された callback() ハンドラーを呼び出します。
send_activities

一連のアクティビティをユーザーに送信します。 サーバーからの応答の配列が返されます。
update_activity

既存のアクティビティを置き換えます。
use

ミドルウェア ハンドラーをアダプターに登録します。

continue_conversation

プロアクティブ メッセージを会話に送信します。 このメソッドを呼び出して、メッセージを会話に事前に送信します。 ほとんどのチャネルでは、ボットがアクティビティをユーザーに送信する前に、ユーザーがボットとの会話を開始する必要があります。

単一テナントはアダプター (コンソール、テストなど) ですが、マルチテナント対応の BotFrameworkAdapter にとって重要です。 :p aram リファレンス: 続行する会話への参照。 :type reference: ConversationReference :p aram コールバック: 結果のボット ターンに対して呼び出すメソッド。 :type callback: Callable :p aram claims_identity: 会話の 。<xref:botframework.connector.auth.ClaimsIdentity> :type claims_identity: <xref:botframework.connector.auth.ClaimsIdentity> :p aram audience:A 値は、プロアクティブ メッセージの受信者を示します。 :type audience: str

async continue_conversation(reference: ConversationReference, callback: Callable, bot_id: str = None, claims_identity: ClaimsIdentity = None, audience: str = None)

パラメーター

名前 説明
bot_id

ボットのアプリケーション ID。 このパラメーターは、 で無視されます

既定値: None
reference
必須
callback
必須
claims_identity
既定値: None
audience
既定値: None

create_conversation

ユーザーとの新しい会話を開始します。 グループのメンバーにメッセージを送信するために使用されます。

async create_conversation(reference: ConversationReference, logic: Callable[[TurnContext], Awaitable] = None, conversation_parameters: ConversationParameters = None, channel_id: str = None, service_url: str = None, credentials: AppCredentials = None)

パラメーター

名前 説明
reference
必須
ConversationReference

テナントを含む会話参照
logic
Callable

会話の作成に使用するロジック

既定値: None
conversation_parameters

会話の作成に使用する情報

既定値: None
channel_id
<xref:typing.str>

チャネルの ID。

既定値: None
service_url
<xref:typing.str>

チャネルのサービス URL エンドポイント。

既定値: None
credentials
<xref:botframework.connector.auth.AppCredentials>

ボットのアプリケーション資格情報。

既定値: None

戻り値

型 説明

実行するキューに登録された作業を表すタスク。

例外

型 説明
It raises a generic exception error.

注釈

会話を開始するには、ボットがそのアカウント情報と、そのチャネルのユーザーのアカウント情報を知っている必要があります。 ほとんどのチャネルでは、直接メッセージ (グループ以外) の会話の開始のみがサポートされています。 アダプターはチャネルで新しい会話を作成し、そのミドルウェア パイプラインを介して会話更新アクティビティをコールバック メソッドに送信します。 指定したユーザーを使用して会話が確立された場合、アクティビティの ID には新しい会話の ID が含まれます。

delete_activity

既存のアクティビティを削除します。

abstract async delete_activity(context: TurnContext, reference: ConversationReference)

パラメーター

名前 説明
context
必須
<xref:botbuilder.core.bot_adapter.TurnContext>

ターンのコンテキスト オブジェクト。
reference
必須
ConversationReference

削除するアクティビティの会話参照。

run_pipeline

アダプター ミドルウェア セットを実行するために親クラスによって呼び出され、チェーンの末尾で渡された callback() ハンドラーを呼び出します。

async run_pipeline(context: TurnContext, callback: Callable[[TurnContext], Awaitable] = None)

パラメーター

名前 説明
context
必須
<xref:botbuilder.core.bot_adapter.TurnContext>

ターンのコンテキスト オブジェクト。
callback
Callable[[<xref:TurnContext>],<xref: Awaitable>]

パイプラインの末尾で実行するコールバック メソッド。

既定値: None

send_activities

一連のアクティビティをユーザーに送信します。 サーバーからの応答の配列が返されます。

abstract async send_activities(context: TurnContext, activities: List[Activity]) -> List[ResourceResponse]

パラメーター

名前 説明
context
必須
<xref:botbuilder.core.bot_adapter.TurnContext>

ターンのコンテキスト オブジェクト。
activities
必須
List[<xref:Activity>]

送信するアクティビティ。

update_activity

既存のアクティビティを置き換えます。

abstract async update_activity(context: TurnContext, activity: Activity)

パラメーター

名前 説明
context
必須
<xref:botbuilder.core.bot_adapter.TurnContext>

ターンのコンテキスト オブジェクト。
activity
必須
Activity

新しい置換アクティビティ。

use

ミドルウェア ハンドラーをアダプターに登録します。

use(middleware)

パラメーター

名前 説明
middleware
必須

登録するミドルウェア。

属性

BOT_CALLBACK_HANDLER_KEY 

BOT_CALLBACK_HANDLER_KEY = 'BotCallbackHandler'

BOT_CONNECTOR_CLIENT_KEY 

BOT_CONNECTOR_CLIENT_KEY = 'ConnectorClient'

BOT_IDENTITY_KEY 

BOT_IDENTITY_KEY = 'BotIdentity'

BOT_OAUTH_SCOPE_KEY 

BOT_OAUTH_SCOPE_KEY = 'botbuilder.core.BotAdapter.OAuthScope'