BotFrameworkHttpAdapter 類別

定義

命名空間:

Microsoft.Bot.Builder.Integration.AspNet.WebApi

組件:

Microsoft.Bot.Builder.Integration.AspNet.WebApi.dll

套件:

Microsoft.Bot.Builder.Integration.AspNet.WebApi v4.22.7

用來處理 Bot Framework HTTP 要求的 Bot Builder 配接器實作。

public class BotFrameworkHttpAdapter : Microsoft.Bot.Builder.Streaming.BotFrameworkHttpAdapterBase, Microsoft.Bot.Builder.Integration.AspNet.WebApi.IBotFrameworkHttpAdapter

type BotFrameworkHttpAdapter = class
    inherit BotFrameworkHttpAdapterBase
    interface IBotFrameworkHttpAdapter

Public Class BotFrameworkHttpAdapter
Inherits BotFrameworkHttpAdapterBase
Implements IBotFrameworkHttpAdapter

繼承

Object

BotAdapter

BotFrameworkAdapter

BotFrameworkHttpAdapterBase

BotFrameworkHttpAdapter

實作

IBotFrameworkHttpAdapter

建構函式

BotFrameworkHttpAdapter(ICredentialProvider, IChannelProvider, HttpClient, ILogger<BotFrameworkHttpAdapter>)	初始化 BotFrameworkHttpAdapter 類別的新執行個體。
BotFrameworkHttpAdapter(ICredentialProvider, IChannelProvider, ILogger<BotFrameworkHttpAdapter>)	初始化 BotFrameworkHttpAdapter 類別的新執行個體。

欄位

BotIdentityKey	Bot 識別金鑰的字串值。 (繼承來源 BotAdapter)
InvokeResponseKey	任何會位於 TurnState 上的 InvokeResponseActivity 索引鍵值。 (繼承來源 BotAdapter)
OAuthScopeKey	OAuth 範圍金鑰的字串值。 (繼承來源 BotAdapter)

屬性

AppCredentialMap	取得此配接器的應用程式 AppCredentials 對應。 (繼承來源 BotFrameworkAdapter)
ChannelProvider	取得這個配接器的通道提供者。 (繼承來源 BotFrameworkAdapter)
ClaimsIdentity	取得或設定這個配接器的宣告識別。 (繼承來源 BotFrameworkHttpAdapterBase)
ConnectedBot	取得或設定連線至此配接器的 Bot。 (繼承來源 BotFrameworkHttpAdapterBase)
CredentialProvider	取得這個配接器的認證提供者。 (繼承來源 BotFrameworkAdapter)
HttpClient	如果指定，取得這個配接器的自訂 HttpClient 。 (繼承來源 BotFrameworkAdapter)
Logger	取得這個配接器的記錄器。 (繼承來源 BotFrameworkAdapter)
MiddlewareSet	取得配接器管線中的中介軟體集合。 (繼承來源 BotAdapter)
OnTurnError	取得或設定錯誤處理常式，這個處理常式可以攔截中介軟體或應用程式中的例外狀況。 (繼承來源 BotAdapter)
RequestHandlers	取得或設定這個配接器的要求處理常式。 (繼承來源 BotFrameworkHttpAdapterBase)

方法

BuildCredentialsAsync(String, String)	用來建置 AppCredentials 物件以取得此 HttpClient 權杖的邏輯。 (繼承來源 BotFrameworkAdapter)
CanProcessOutgoingActivity(Activity)	評估是否可能處理傳出活動。 (繼承來源 BotFrameworkHttpAdapterBase)
ConnectNamedPipeAsync(String, IBot, String)	建立新的 StreamingRequestHandler 以接聽指定的具名管道，並將要求傳遞至此配接器。 (繼承來源 BotFrameworkHttpAdapterBase)
ContinueConversationAsync(ClaimsIdentity, Activity, BotCallbackHandler, CancellationToken)	將主動式訊息傳送至交談。 (繼承來源 BotAdapter)
ContinueConversationAsync(ClaimsIdentity, Activity, String, BotCallbackHandler, CancellationToken)	將主動式訊息傳送至交談。 (繼承來源 BotAdapter)
ContinueConversationAsync(ClaimsIdentity, ConversationReference, BotCallbackHandler, CancellationToken)	將主動式訊息從 Bot 傳送至交談。 (繼承來源 BotFrameworkAdapter)
ContinueConversationAsync(ClaimsIdentity, ConversationReference, String, BotCallbackHandler, CancellationToken)	將主動式訊息從 Bot 傳送至交談。 (繼承來源 BotFrameworkAdapter)
ContinueConversationAsync(String, Activity, BotCallbackHandler, CancellationToken)	將主動式訊息傳送至交談。 (繼承來源 BotAdapter)
ContinueConversationAsync(String, ConversationReference, BotCallbackHandler, CancellationToken)	將主動式訊息從 Bot 傳送至交談。 (繼承來源 BotFrameworkAdapter)
CreateConversationAsync(String, String, AppCredentials, ConversationParameters, BotCallbackHandler, CancellationToken)	在指定的通道上建立交談。 (繼承來源 BotFrameworkAdapter)
CreateConversationAsync(String, String, AppCredentials, ConversationParameters, BotCallbackHandler, ConversationReference, CancellationToken)	已淘汰. 在指定的通道上建立交談。 多載會接收 ConversationReference，包括租使用者。 (繼承來源 BotFrameworkAdapter)
CreateConversationAsync(String, String, MicrosoftAppCredentials, ConversationParameters, BotCallbackHandler, CancellationToken)	在指定的通道上建立交談。 (繼承來源 BotFrameworkAdapter)
CreateConversationAsync(String, String, MicrosoftAppCredentials, ConversationParameters, BotCallbackHandler, ConversationReference, CancellationToken)	已淘汰. 在指定的通道上建立交談。 多載會接收 ConversationReference，包括租使用者。 (繼承來源 BotFrameworkAdapter)
CreateConversationAsync(String, String, String, String, ConversationParameters, BotCallbackHandler, CancellationToken)	在指定的通道上建立交談。 (繼承來源 BotAdapter)
CreateOAuthApiClientAsync(ITurnContext)	建立 Bot 的 OAuth 用戶端。 (繼承來源 BotFrameworkAdapter)
CreateOAuthApiClientAsync(ITurnContext, AppCredentials)	使用認證建立 Bot 的 OAuth 用戶端。 (繼承來源 BotFrameworkAdapter)
DeleteActivityAsync(ITurnContext, ConversationReference, CancellationToken)	刪除交談中的現有活動。 (繼承來源 BotFrameworkAdapter)
DeleteConversationMemberAsync(ITurnContext, String, CancellationToken)	從目前的交談中移除成員。 (繼承來源 BotFrameworkAdapter)
Dispose()	用來處理 Bot Framework HTTP 要求的 Bot Builder 配接器實作。 (繼承來源 BotFrameworkHttpAdapterBase)
Dispose(Boolean)	處置 的資源 StreamingRequestHandler 。 (繼承來源 BotFrameworkHttpAdapterBase)
ExchangeTokenAsync(ITurnContext, AppCredentials, String, String, TokenExchangeRequest, CancellationToken)	執行權杖交換作業，例如單一登入。 (繼承來源 BotFrameworkAdapter)
ExchangeTokenAsync(ITurnContext, String, String, TokenExchangeRequest, CancellationToken)	執行權杖交換作業，例如單一登入。 (繼承來源 BotFrameworkAdapter)
GetAadTokensAsync(ITurnContext, AppCredentials, String, String[], String, CancellationToken)	使用自訂的 AppCredentials，擷取已設定連線上特定資源的 Azure Active Directory 權杖。 (繼承來源 BotFrameworkAdapter)
GetAadTokensAsync(ITurnContext, String, String[], String, CancellationToken)	使用 Bot 的 AppCredentials，擷取已設定連線上特定資源的 Azure Active Directory 權杖。 (繼承來源 BotFrameworkAdapter)
GetActivityMembersAsync(ITurnContext, String, CancellationToken)	列出指定活動的成員。 (繼承來源 BotFrameworkAdapter)
GetConversationMembersAsync(ITurnContext, CancellationToken)	列出目前交談的成員。 (繼承來源 BotFrameworkAdapter)
GetConversationsAsync(ITurnContext, String, CancellationToken)	列出此 Bot 參與指定通道伺服器的交談。 通道伺服器會傳回頁面的結果，而每個頁面都會包含 ， continuationToken 可用來從伺服器擷取下一頁的結果。 (繼承來源 BotFrameworkAdapter)
GetConversationsAsync(String, MicrosoftAppCredentials, String, CancellationToken)	列出此 Bot 參與指定通道伺服器的交談。 通道伺服器會傳回頁面的結果，而每個頁面都會包含 ， continuationToken 可用來從伺服器擷取下一頁的結果。 (繼承來源 BotFrameworkAdapter)
GetOauthSignInLinkAsync(ITurnContext, AppCredentials, String, CancellationToken)	使用自訂的 AppCredentials，取得要傳送給使用者以進行連線名稱登入的原始登入連結。 (繼承來源 BotFrameworkAdapter)
GetOauthSignInLinkAsync(ITurnContext, AppCredentials, String, String, String, CancellationToken)	使用自訂的 AppCredentials，取得要傳送給使用者以進行連線名稱登入的原始登入連結。 (繼承來源 BotFrameworkAdapter)
GetOauthSignInLinkAsync(ITurnContext, String, CancellationToken)	使用 Bot 的 AppCredentials，取得要傳送給使用者以進行連線名稱登入的原始登入連結。 (繼承來源 BotFrameworkAdapter)
GetOauthSignInLinkAsync(ITurnContext, String, String, String, CancellationToken)	使用 Bot 的 AppCredentials，取得要傳送給使用者以進行連線名稱登入的原始登入連結。 (繼承來源 BotFrameworkAdapter)
GetSignInResourceAsync(ITurnContext, AppCredentials, String, String, String, CancellationToken)	取得要傳送給使用者以登入以取得連線名稱的原始登入連結。 (繼承來源 BotFrameworkAdapter)
GetSignInResourceAsync(ITurnContext, String, CancellationToken)	取得要傳送給使用者以登入以取得連線名稱的原始登入連結。 (繼承來源 BotFrameworkAdapter)
GetSignInResourceAsync(ITurnContext, String, String, String, CancellationToken)	取得要傳送給使用者以登入以取得連線名稱的原始登入連結。 (繼承來源 BotFrameworkAdapter)
GetTokenStatusAsync(ITurnContext, AppCredentials, String, String, CancellationToken)	使用自訂的 AppCredentials，擷取指定使用者每個已設定連線的權杖狀態。 (繼承來源 BotFrameworkAdapter)
GetTokenStatusAsync(ITurnContext, String, String, CancellationToken)	使用 Bot 的 AppCredentials，擷取指定使用者每個已設定連線的權杖狀態。 (繼承來源 BotFrameworkAdapter)
GetUserTokenAsync(ITurnContext, AppCredentials, String, String, CancellationToken)	嘗試使用自訂的 AppCredentials，擷取登入流程中使用者的權杖。 (繼承來源 BotFrameworkAdapter)
GetUserTokenAsync(ITurnContext, String, String, CancellationToken)	嘗試使用 Bot 的 AppCredentials，擷取登入流程中使用者的權杖。 (繼承來源 BotFrameworkAdapter)
ProcessActivityAsync(ClaimsIdentity, Activity, BotCallbackHandler, CancellationToken)	建立回合內容，並執行傳入活動的中介軟體管線。 (繼承來源 BotFrameworkAdapter)
ProcessActivityAsync(String, Activity, BotCallbackHandler, CancellationToken)	建立回合內容，並執行傳入活動的中介軟體管線。 (繼承來源 BotFrameworkAdapter)
ProcessAsync(HttpRequestMessage, HttpResponseMessage, IBot, CancellationToken)	這個方法可以從任何控制器實作上的 POST 方法內部呼叫。
ProcessOutgoingActivityAsync(ITurnContext, Activity, CancellationToken)	傳送傳出活動。 (繼承來源 BotFrameworkHttpAdapterBase)
ProcessStreamingActivityAsync(Activity, BotCallbackHandler, CancellationToken)	處理從串流通道傳送之活動的主要配接器方法。 建立回合內容，並執行傳入活動的中介軟體管線。 在 Null 引數上擲回 ArgumentNullException 。 (繼承來源 BotFrameworkHttpAdapterBase)
RunPipelineAsync(ITurnContext, BotCallbackHandler, CancellationToken)	啟動目前 Bot 回合的活動處理。 (繼承來源 BotAdapter)
SendActivitiesAsync(ITurnContext, Activity[], CancellationToken)	將活動傳送至交談。 (繼承來源 BotFrameworkAdapter)
SendStreamingActivityAsync(Activity, CancellationToken)	傳送活動。 (繼承來源 BotFrameworkHttpAdapterBase)
SignOutUserAsync(ITurnContext, AppCredentials, String, String, CancellationToken)	使用自訂的 AppCredentials，以權杖伺服器將使用者登出。 (繼承來源 BotFrameworkAdapter)
SignOutUserAsync(ITurnContext, String, String, CancellationToken)	使用 Bot 的 AppCredentials，以權杖伺服器將使用者登出。 (繼承來源 BotFrameworkAdapter)
UpdateActivityAsync(ITurnContext, Activity, CancellationToken)	取代交談中的現有活動。 (繼承來源 BotFrameworkAdapter)
Use(IMiddleware)	將中介軟體新增至配接器的管線。 (繼承來源 BotFrameworkAdapter)

明確介面實作

IConnectorClientBuilder.CreateConnectorClientAsync(String, ClaimsIdentity, String, CancellationToken)

用來處理 Bot Framework HTTP 要求的 Bot Builder 配接器實作。 (繼承來源 BotFrameworkAdapter)

擴充方法

UseBotState(BotAdapter, BotState[])	將中介軟體新增至配接器，以在回合內容上註冊一或多個 BotState 物件。 中介軟體會在每次回合開始時，于回合內容上註冊狀態物件。
UseState(BotAdapter, UserState, ConversationState, Boolean)	已淘汰. 向配接器註冊使用者和交談狀態物件。 這些物件可透過回合內容的 . TurnStateGet<T>() 方法取得。
UseStorage(BotAdapter, IStorage)	將中介軟體新增至配接器，以在回合內容上註冊 IStorage 物件。 中介軟體會在每次回合開始時，于回合內容上註冊狀態物件。