BotFrameworkHttpAdapter 類別

定義

命名空間:: Microsoft.Bot.Builder.Integration.AspNet.WebApi

組件:: Microsoft.Bot.Builder.Integration.AspNet.WebApi.dll

套件:: Microsoft.Bot.Builder.Integration.AspNet.WebApi v4.22.7

重要

部分資訊涉及發行前產品，在發行之前可能會有大幅修改。 Microsoft 對此處提供的資訊，不做任何明確或隱含的瑕疵擔保。

一個用於處理機器人框架 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

建構函式

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

欄位

名稱	Description
BotIdentityKey	機器人身份鍵的字串值。 (繼承來源 BotAdapter)
InvokeResponseKey	任何 InvokeResponseActivity 在 TurnState 上的關鍵值。 (繼承來源 BotAdapter)
OAuthScopeKey	OAuth 範圍鍵的字串值。 (繼承來源 BotAdapter)

屬性

名稱	Description
AppCredentialMap	它會取得這個轉接器應用程式的 AppCredentials 映射。 (繼承來源 BotFrameworkAdapter)
ChannelProvider	取得這個配接器的通道提供者。 (繼承來源 BotFrameworkAdapter)
ClaimsIdentity	取得或設定此轉接器的理賠身份。 (繼承來源 BotFrameworkHttpAdapterBase)
ConnectedBot	讓機器人連接到這個轉接器。 (繼承來源 BotFrameworkHttpAdapterBase)
CredentialProvider	取得這個配接器的認證提供者。 (繼承來源 BotFrameworkAdapter)
HttpClient	如果有指定，我會取得這個轉接器的客製化 HttpClient 版本。 (繼承來源 BotFrameworkAdapter)
Logger	拿到這個轉接器的記錄器。 (繼承來源 BotFrameworkAdapter)
MiddlewareSet	取得配接器管線中的中間件集合。 (繼承來源 BotAdapter)
OnTurnError	取得或設定錯誤處理程式，這個處理程式可以攔截中間件或應用程式中的例外狀況。 (繼承來源 BotAdapter)
RequestHandlers	取得或設定此介面卡的請求處理器。 (繼承來源 BotFrameworkHttpAdapterBase)

方法

名稱	Description
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)	已淘汰. 在指定的通道上建立交談。 Overload 會收到包含租戶的 ConversationReference。 (繼承來源 BotFrameworkAdapter)
CreateConversationAsync(String, String, MicrosoftAppCredentials, ConversationParameters, BotCallbackHandler, CancellationToken)	在指定的通道上建立交談。 (繼承來源 BotFrameworkAdapter)
CreateConversationAsync(String, String, MicrosoftAppCredentials, ConversationParameters, BotCallbackHandler, ConversationReference, CancellationToken)	已淘汰. 在指定的通道上建立交談。 Overload 會收到包含租戶的 ConversationReference。 (繼承來源 BotFrameworkAdapter)
CreateConversationAsync(String, String, String, String, ConversationParameters, BotCallbackHandler, CancellationToken)	在指定的通道上建立交談。 (繼承來源 BotAdapter)
CreateOAuthApiClientAsync(ITurnContext, AppCredentials)	為機器人建立一個帶有憑證的 OAuth 用戶端。 (繼承來源 BotFrameworkAdapter)
CreateOAuthApiClientAsync(ITurnContext)	建立 Bot 的 OAuth 用戶端。 (繼承來源 BotFrameworkAdapter)
DeleteActivityAsync(ITurnContext, ConversationReference, CancellationToken)	刪除交談中的現有活動。 (繼承來源 BotFrameworkAdapter)
DeleteConversationMemberAsync(ITurnContext, String, CancellationToken)	將一名成員從目前對話中移除。 (繼承來源 BotFrameworkAdapter)
Dispose()	一個用於處理機器人框架 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)	利用機器人的 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)	嘗試利用機器人的 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)	主要的轉接器方法，用於處理從串流頻道傳送的活動。建立回合內容，並執行傳入活動的中間件管線。還會 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)	利用機器人的 AppCredentials 將使用者登出憑證伺服器。 (繼承來源 BotFrameworkAdapter)
UpdateActivityAsync(ITurnContext, Activity, CancellationToken)	取代交談中的現有活動。 (繼承來源 BotFrameworkAdapter)
Use(IMiddleware)	將中間件新增至配接器的管線。 (繼承來源 BotFrameworkAdapter)

明確介面實作

名稱	Description
IConnectorClientBuilder.CreateConnectorClientAsync(String, ClaimsIdentity, String, CancellationToken)	一個用於處理機器人框架 HTTP 請求的 Bot Builder 介面卡實作。 (繼承來源 BotFrameworkAdapter)

擴充方法

名稱	Description
UseBotState(BotAdapter, BotState[])	在轉接器中加入中介軟體，以便在回合上下文中註冊一個或多個 BotState 物件。中間件會在每次回合開始時，於回合內容上註冊狀態物件。
UseState(BotAdapter, UserState, ConversationState, Boolean)	已淘汰. 向介面卡註冊使用者及會話狀態物件。這些物件將透過回合上下文的 TurnState.Get<T>() 方法提供。
UseStorage(BotAdapter, IStorage)	在轉接器中加入中介軟體，以便在回合上下文中註冊 IStorage 物件。中間件會在每次回合開始時，於回合內容上註冊狀態物件。

適用於