BotFrameworkAdapter 類別

can_process_outgoing_activity(activity: Activity) -> bool

參數

繼續與使用者交談。

和 通常會在 config.py的 MicrosoftAppId 參數中找到。 ：type bot_id： <xref:typing.str> :p aram claims_identity： Bot 宣告身分識別 ：type claims_identity： <xref:botframework.connector.auth.ClaimsIdentity> :p aram 物件： ：類型物件： <xref:typing.str>

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

參數

傳回

例外狀況

備註

這通常稱為 Bot 主動傳訊 流程，因為它可讓 Bot 主動將訊息傳送至已處於通訊中的交談或使用者。 此函式會啟用傳送通知或優惠券給使用者的案例。

實作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)

參數

傳回

例外狀況

備註

若要開始交談，您的 Bot 必須知道其帳戶資訊和該通道上的用戶帳戶資訊。 大部分的通道都只支援起始直接訊息（非群組）交談。 配接器會嘗試在通道上建立新的交談，然後透過其中間件管線將交談更新活動傳送至回呼方法。 如果與指定的使用者建立交談，活動的標識碼將會包含新交談的標識碼。

刪除先前傳送至通道的活動。 請注意，並非所有通道都支援這項功能。

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 中的 Activity。 ：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]

參數

傳回

列出指定活動的成員。

如果未指定，則會使用目前的活動標識符。

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)

參數

傳回

例外狀況

列出此 Bot 參與指定通道伺服器的交談。

context.activity.serviceUrl ：type service_url： str

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

參數

傳回

例外狀況

備註

通道伺服器會傳回頁面的結果，而且每個頁面都會包含 continuationToken，可用來從伺服器擷取下一頁的結果。 如果工作順利完成，結果會包含目前交談成員的頁面。 此多載可以從交談內容外部呼叫，因為只需要 Bot 的服務 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： （選擇性） AppCredentials for OAuth。 ：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)

參數

傳回

備註

此類別會處理 Bot 網頁伺服器所接收的活動。 這包括從用戶傳送的任何訊息，也是驅動通常稱為 Bot 的方法，回應式傳訊 流程。 呼叫此方法，以回應方式將訊息傳送至交談。 如果工作順利完成，則會傳回 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)

參數

傳回

例外狀況

備註

如果成功傳送活動，工作結果會包含 ResourceResponse 物件，其中包含指派給活動的接收通道標識碼。 呼叫此函式之前，請將取代活動的標識碼設定為要取代之活動的標識碼。