BotFrameworkHttpAdapter Class

Reference

Definition

Namespace:: Microsoft.Bot.Builder.Integration.AspNet.WebApi

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

Package:: Microsoft.Bot.Builder.Integration.AspNet.WebApi v4.18.1

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

A Bot Builder Adapter implementation used to handled bot Framework HTTP requests.

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

Inheritance: Object

BotAdapter

BotFrameworkAdapter

BotFrameworkHttpAdapterBase
BotFrameworkHttpAdapter

Implements: IBotFrameworkHttpAdapter

Constructors

BotFrameworkHttpAdapter(ICredentialProvider, IChannelProvider, HttpClient, ILogger<BotFrameworkHttpAdapter>)	Initializes a new instance of the BotFrameworkHttpAdapter class.
BotFrameworkHttpAdapter(ICredentialProvider, IChannelProvider, ILogger<BotFrameworkHttpAdapter>)	Initializes a new instance of the BotFrameworkHttpAdapter class.

Fields

BotIdentityKey	The string value for the bot identity key. (Inherited from BotAdapter)
InvokeResponseKey	The key value for any InvokeResponseActivity that would be on the TurnState. (Inherited from BotAdapter)
OAuthScopeKey	The string value for the OAuth scope key. (Inherited from BotAdapter)

Properties

AppCredentialMap	Gets the map of applications to AppCredentials for this adapter. (Inherited from BotFrameworkAdapter)
ChannelProvider	Gets the channel provider for this adapter. (Inherited from BotFrameworkAdapter)
ClaimsIdentity	Gets or sets the claims identity for this adapter. (Inherited from BotFrameworkHttpAdapterBase)
ConnectedBot	Gets or sets the bot connected to this adapter. (Inherited from BotFrameworkHttpAdapterBase)
CredentialProvider	Gets the credential provider for this adapter. (Inherited from BotFrameworkAdapter)
HttpClient	Gets the custom HttpClient for this adapter if specified. (Inherited from BotFrameworkAdapter)
Logger	Gets the logger for this adapter. (Inherited from BotFrameworkAdapter)
MiddlewareSet	Gets the collection of middleware in the adapter's pipeline. (Inherited from BotAdapter)
OnTurnError	Gets or sets an error handler that can catch exceptions in the middleware or application. (Inherited from BotAdapter)
RequestHandlers	Gets or sets the request handlers for this adapter. (Inherited from BotFrameworkHttpAdapterBase)

Methods

BuildCredentialsAsync(String, String)	Logic to build an AppCredentials object to be used to acquire tokens for this HttpClient. (Inherited from BotFrameworkAdapter)
CanProcessOutgoingActivity(Activity)	Evaluates if processing an outgoing activity is possible. (Inherited from BotFrameworkHttpAdapterBase)
ConnectNamedPipeAsync(String, IBot, String)	Creates a new StreamingRequestHandler to listen to the specified Named Pipe and pass requests to this adapter. (Inherited from BotFrameworkHttpAdapterBase)
ContinueConversationAsync(ClaimsIdentity, Activity, BotCallbackHandler, CancellationToken)	Sends a proactive message to a conversation. (Inherited from BotAdapter)
ContinueConversationAsync(ClaimsIdentity, Activity, String, BotCallbackHandler, CancellationToken)	Sends a proactive message to a conversation. (Inherited from BotAdapter)
ContinueConversationAsync(ClaimsIdentity, ConversationReference, BotCallbackHandler, CancellationToken)	Sends a proactive message from the bot to a conversation. (Inherited from BotFrameworkAdapter)
ContinueConversationAsync(ClaimsIdentity, ConversationReference, String, BotCallbackHandler, CancellationToken)	Sends a proactive message from the bot to a conversation. (Inherited from BotFrameworkAdapter)
ContinueConversationAsync(String, Activity, BotCallbackHandler, CancellationToken)	Sends a proactive message to a conversation. (Inherited from BotAdapter)
ContinueConversationAsync(String, ConversationReference, BotCallbackHandler, CancellationToken)	Sends a proactive message from the bot to a conversation. (Inherited from BotFrameworkAdapter)
CreateConversationAsync(String, String, AppCredentials, ConversationParameters, BotCallbackHandler, CancellationToken)	Creates a conversation on the specified channel. (Inherited from BotFrameworkAdapter)
CreateConversationAsync(String, String, AppCredentials, ConversationParameters, BotCallbackHandler, ConversationReference, CancellationToken)	Obsolete. Creates a conversation on the specified channel. Overload receives a ConversationReference including the tenant. (Inherited from BotFrameworkAdapter)
CreateConversationAsync(String, String, MicrosoftAppCredentials, ConversationParameters, BotCallbackHandler, CancellationToken)	Creates a conversation on the specified channel. (Inherited from BotFrameworkAdapter)
CreateConversationAsync(String, String, MicrosoftAppCredentials, ConversationParameters, BotCallbackHandler, ConversationReference, CancellationToken)	Obsolete. Creates a conversation on the specified channel. Overload receives a ConversationReference including the tenant. (Inherited from BotFrameworkAdapter)
CreateConversationAsync(String, String, String, String, ConversationParameters, BotCallbackHandler, CancellationToken)	Creates a conversation on the specified channel. (Inherited from BotAdapter)
CreateOAuthApiClientAsync(ITurnContext)	Creates an OAuth client for the bot. (Inherited from BotFrameworkAdapter)
CreateOAuthApiClientAsync(ITurnContext, AppCredentials)	Creates an OAuth client for the bot with the credentials. (Inherited from BotFrameworkAdapter)
DeleteActivityAsync(ITurnContext, ConversationReference, CancellationToken)	Deletes an existing activity in the conversation. (Inherited from BotFrameworkAdapter)
DeleteConversationMemberAsync(ITurnContext, String, CancellationToken)	Removes a member from the current conversation. (Inherited from BotFrameworkAdapter)
Dispose()	(Inherited from BotFrameworkHttpAdapterBase)
Dispose(Boolean)	Disposes resources of the StreamingRequestHandler. (Inherited from BotFrameworkHttpAdapterBase)
ExchangeTokenAsync(ITurnContext, AppCredentials, String, String, TokenExchangeRequest, CancellationToken)	Performs a token exchange operation such as for single sign-on. (Inherited from BotFrameworkAdapter)
ExchangeTokenAsync(ITurnContext, String, String, TokenExchangeRequest, CancellationToken)	Performs a token exchange operation such as for single sign-on. (Inherited from BotFrameworkAdapter)
GetAadTokensAsync(ITurnContext, AppCredentials, String, String[], String, CancellationToken)	Retrieves Azure Active Directory tokens for particular resources on a configured connection, using customized AppCredentials. (Inherited from BotFrameworkAdapter)
GetAadTokensAsync(ITurnContext, String, String[], String, CancellationToken)	Retrieves Azure Active Directory tokens for particular resources on a configured connection, using the bot's AppCredentials. (Inherited from BotFrameworkAdapter)
GetActivityMembersAsync(ITurnContext, String, CancellationToken)	Lists the members of a given activity. (Inherited from BotFrameworkAdapter)
GetConversationMembersAsync(ITurnContext, CancellationToken)	Lists the members of the current conversation. (Inherited from BotFrameworkAdapter)
GetConversationsAsync(ITurnContext, String, CancellationToken)	Lists the Conversations in which this bot has participated for a given channel server. The channel server returns results in pages and each page will include a `continuationToken` that can be used to fetch the next page of results from the server. (Inherited from BotFrameworkAdapter)
GetConversationsAsync(String, MicrosoftAppCredentials, String, CancellationToken)	Lists the Conversations in which this bot has participated for a given channel server. The channel server returns results in pages and each page will include a `continuationToken` that can be used to fetch the next page of results from the server. (Inherited from BotFrameworkAdapter)
GetOauthSignInLinkAsync(ITurnContext, AppCredentials, String, CancellationToken)	Get the raw signin link to be sent to the user for signin for a connection name, using customized AppCredentials. (Inherited from BotFrameworkAdapter)
GetOauthSignInLinkAsync(ITurnContext, AppCredentials, String, String, String, CancellationToken)	Get the raw signin link to be sent to the user for signin for a connection name, using customized AppCredentials. (Inherited from BotFrameworkAdapter)
GetOauthSignInLinkAsync(ITurnContext, String, CancellationToken)	Get the raw signin link to be sent to the user for signin for a connection name, using the bot's AppCredentials. (Inherited from BotFrameworkAdapter)
GetOauthSignInLinkAsync(ITurnContext, String, String, String, CancellationToken)	Get the raw signin link to be sent to the user for signin for a connection name, using the bot's AppCredentials. (Inherited from BotFrameworkAdapter)
GetSignInResourceAsync(ITurnContext, AppCredentials, String, String, String, CancellationToken)	Get the raw signin link to be sent to the user for signin for a connection name. (Inherited from BotFrameworkAdapter)
GetSignInResourceAsync(ITurnContext, String, CancellationToken)	Get the raw signin link to be sent to the user for signin for a connection name. (Inherited from BotFrameworkAdapter)
GetSignInResourceAsync(ITurnContext, String, String, String, CancellationToken)	Get the raw signin link to be sent to the user for signin for a connection name. (Inherited from BotFrameworkAdapter)
GetTokenStatusAsync(ITurnContext, AppCredentials, String, String, CancellationToken)	Retrieves the token status for each configured connection for the given user, using customized AppCredentials. (Inherited from BotFrameworkAdapter)
GetTokenStatusAsync(ITurnContext, String, String, CancellationToken)	Retrieves the token status for each configured connection for the given user, using the bot's AppCredentials. (Inherited from BotFrameworkAdapter)
GetUserTokenAsync(ITurnContext, AppCredentials, String, String, CancellationToken)	Attempts to retrieve the token for a user that's in a login flow, using customized AppCredentials. (Inherited from BotFrameworkAdapter)
GetUserTokenAsync(ITurnContext, String, String, CancellationToken)	Attempts to retrieve the token for a user that's in a login flow, using the bot's AppCredentials. (Inherited from BotFrameworkAdapter)
ProcessActivityAsync(ClaimsIdentity, Activity, BotCallbackHandler, CancellationToken)	Creates a turn context and runs the middleware pipeline for an incoming activity. (Inherited from BotFrameworkAdapter)
ProcessActivityAsync(String, Activity, BotCallbackHandler, CancellationToken)	Creates a turn context and runs the middleware pipeline for an incoming activity. (Inherited from BotFrameworkAdapter)
ProcessAsync(HttpRequestMessage, HttpResponseMessage, IBot, CancellationToken)	This method can be called from inside a POST method on any Controller implementation.
ProcessOutgoingActivityAsync(ITurnContext, Activity, CancellationToken)	Sends an outgoing activity. (Inherited from BotFrameworkHttpAdapterBase)
ProcessStreamingActivityAsync(Activity, BotCallbackHandler, CancellationToken)	Primary adapter method for processing activities sent from streaming channel. Creates a turn context and runs the middleware pipeline for an incoming activity. Throws ArgumentNullException on null arguments. (Inherited from BotFrameworkHttpAdapterBase)
RunPipelineAsync(ITurnContext, BotCallbackHandler, CancellationToken)	Starts activity processing for the current bot turn. (Inherited from BotAdapter)
SendActivitiesAsync(ITurnContext, Activity[], CancellationToken)	Sends activities to the conversation. (Inherited from BotFrameworkAdapter)
SendStreamingActivityAsync(Activity, CancellationToken)	Sends an activity. (Inherited from BotFrameworkHttpAdapterBase)
SignOutUserAsync(ITurnContext, AppCredentials, String, String, CancellationToken)	Signs the user out with the token server, using customized AppCredentials. (Inherited from BotFrameworkAdapter)
SignOutUserAsync(ITurnContext, String, String, CancellationToken)	Signs the user out with the token server, using the bot's AppCredentials. (Inherited from BotFrameworkAdapter)
UpdateActivityAsync(ITurnContext, Activity, CancellationToken)	Replaces an existing activity in the conversation. (Inherited from BotFrameworkAdapter)
Use(IMiddleware)	Adds middleware to the adapter's pipeline. (Inherited from BotFrameworkAdapter)

Explicit Interface Implementations

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

(Inherited from BotFrameworkAdapter)

Extension Methods

UseBotState(BotAdapter, BotState[])	Adds middleware to the adapter to register one or more BotState objects on the turn context. The middleware registers the state objects on the turn context at the start of each turn.
UseState(BotAdapter, UserState, ConversationState, Boolean)	Obsolete. Registers user and conversation state objects with the adapter. These objects will be available via the turn context's TurnState.Get<T>() method.
UseStorage(BotAdapter, IStorage)	Adds middleware to the adapter to register an IStorage object on the turn context. The middleware registers the state objects on the turn context at the start of each turn.

Applies to