BotFrameworkAdapter クラス

can_process_outgoing_activity(activity: Activity) -> bool

パラメーター

ユーザーとの会話を続行します。

一般に、config.pyの MicrosoftAppId パラメーターにあります。 :type bot_id: <xref:typing.str> :p aram claims_identity: ボット要求 ID :type claims_identity: <xref:botframework.connector.auth.ClaimsIdentity> :p aram audience: :type audience: <xref:typing.str>

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

パラメーター

戻り値

例外

注釈

これは、多くの場合、ボットが既に通信中の会話またはユーザーにメッセージをプロアクティブに送信できるように、プロアクティブ メッセージング フローを ボットと呼ばれます。 ユーザーに通知やクーポンを送信するなどのシナリオは、この関数によって有効になります。

ConnectorClientProvider.create_connector_clientの実装。

async create_connector_client(service_url: str, identity: ClaimsIdentity = None, audience: str = None) -> ConnectorClient

パラメーター

戻り値

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

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)

パラメーター

戻り値

例外

注釈

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

以前にチャネルに送信されたアクティビティを削除します。 すべてのチャネルがこの機能をサポートしているわけではないことに注意してください。

async delete_activity(context: TurnContext, reference: ConversationReference)

パラメーター

戻り値

例外

現在の会話からメンバーを削除します。

async delete_conversation_member(context: TurnContext, member_id: str) -> None

パラメーター

戻り値

例外

async exchange_token(turn_context: TurnContext, connection_name: str, user_id: str, exchange_request: TokenExchangeRequest) -> TokenResponse

パラメーター

async exchange_token_from_credentials(turn_context: TurnContext, oauth_app_credentials: AppCredentials, connection_name: str, user_id: str, exchange_request: TokenExchangeRequest) -> TokenResponse

パラメーター

構成された接続上の特定のリソースの Azure Active Directory トークンを取得します。

TurnContext のアクティビティから。 :type user_id: str :p aram oauth_app_credentials: (省略可能) OAuth の AppCredentials。 :type oauth_app_credentials: <xref:botframework.connector.auth.AppCredential>

async get_aad_tokens(context: TurnContext, connection_name: str, resource_urls: List[str], user_id: str = None, oauth_app_credentials: AppCredentials = None) -> Dict[str, TokenResponse]

パラメーター

戻り値

特定のアクティビティのメンバーを一覧表示します。

指定しない場合は、現在のアクティビティ ID が使用されます。

async get_activity_members(context: TurnContext, activity_id: str)

パラメーター

戻り値

例外

現在の会話のメンバーを取得します。

async get_conversation_member(context: TurnContext, member_id: str) -> ChannelAccount

パラメーター

戻り値

例外

現在の会話のメンバーを一覧表示します。

async get_conversation_members(context: TurnContext)

パラメーター

戻り値

例外

このボットが特定のチャネル サーバーに参加した会話を一覧表示します。

context.activity.serviceUrl :type service_url: str

async get_conversations(service_url: str, credentials: AppCredentials, continuation_token: str = None)

パラメーター

戻り値

例外

注釈

チャネル サーバーは結果をページで返し、各ページには、サーバーから結果の次のページをフェッチするために使用できる continuationToken が含まれます。 タスクが正常に完了すると、結果には現在の会話のメンバーのページが含まれます。 このオーバーロードは、ボットのサービス URL と資格情報のみが必要であり、会話のコンテキストの外部から呼び出される場合があります。

接続名のサインインのためにユーザーに送信される未加工のサインイン リンクを取得します。

async get_oauth_sign_in_link(context: TurnContext, connection_name: str, final_redirect: str = None, oauth_app_credentials: AppCredentials = None) -> str

パラメーター

戻り値

async get_sign_in_resource_from_user(turn_context: TurnContext, connection_name: str, user_id: str, final_redirect: str = None) -> SignInUrlResponse

パラメーター

async get_sign_in_resource_from_user_and_credentials(turn_context: TurnContext, oauth_app_credentials: AppCredentials, connection_name: str, user_id: str, final_redirect: str = None) -> SignInUrlResponse

パラメーター

特定のユーザーに対して構成された各接続のトークンの状態を取得します。

空白にすると、構成されているすべての接続のトークンの状態が返されます。 :type include_filter: str :p aram oauth_app_credentials: (省略可能) OAuth の AppCredentials。 :type oauth_app_credentials: <xref:botframework.connector.auth.AppCredential>

async get_token_status(context: TurnContext, connection_name: str = None, user_id: str = None, include_filter: str = None, oauth_app_credentials: AppCredentials = None) -> List[TokenStatus]

パラメーター

戻り値

ログイン フロー内のユーザーのトークンの取得を試みます。

:p aram magic_code" (省略可能) ユーザーがコードを入力して、:str magic_code" str :p aram oauth_app_credentials: (省略可能) OAuth の AppCredentials を検証しました。 :type oauth_app_credentials: <xref:botframework.connector.auth.AppCredential>

async get_user_token(context: TurnContext, connection_name: str, magic_code: str = None, oauth_app_credentials: AppCredentials = None) -> TokenResponse

パラメーター

戻り値

例外

static key_for_app_credentials(app_id: str, scope: str)

パラメーター

static key_for_connector_client(service_url: str, app_id: str, scope: str)

パラメーター

要求 :p aram req: :return を解析して検証します。

async static parse_request(req)

パラメーター

ターン コンテキストを作成し、受信アクティビティのミドルウェア パイプラインを実行します。

async process_activity(req, auth_header: str, logic: Callable)

パラメーター

戻り値

注釈

このクラスは、ボット Web サーバーによって受信されたアクティビティを処理します。 これには、ユーザーから送信されたすべてのメッセージが含まれます。これは、リアクティブ メッセージング フロー ボットと呼ばれるものを駆動する方法です。 このメソッドを呼び出して、メッセージを会話に事後対応的に送信します。 タスクが正常に完了すると、InvokeResponse が返されます。然も無くば。 null が返されます。

async process_activity_with_identity(activity: Activity, identity: ClaimsIdentity, logic: Callable)

パラメーター

async process_outgoing_activity(turn_context: TurnContext, activity: Activity) -> ResourceResponse

パラメーター

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

パラメーター

トークン サーバーを使用してユーザーをサインアウトします。

async sign_out_user(context: TurnContext, connection_name: str = None, user_id: str = None, oauth_app_credentials: AppCredentials = None)

パラメーター

以前にチャネルに送信されたアクティビティを置き換えます。 すべてのチャネルがこの機能をサポートしているわけではないことに注意してください。

async update_activity(context: TurnContext, activity: Activity)

パラメーター

戻り値

例外

注釈

アクティビティが正常に送信された場合、タスクの結果には、受信チャネルがアクティビティに割り当てた ID を含む ResourceResponse オブジェクトが含まれます。 この関数を呼び出す前に、置換アクティビティの ID を置換するアクティビティの ID に設定します。