CloudAdapterBase Class

Reference

Definition

Namespace:: Microsoft.Bot.Builder

Assembly:: Microsoft.Bot.Builder.dll

Package:: Microsoft.Bot.Builder 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.

An adapter that implements the Bot Framework Protocol and can be hosted in different cloud environmens both public and private.

public abstract class CloudAdapterBase : Microsoft.Bot.Builder.BotAdapter

type CloudAdapterBase = class
    inherit BotAdapter

Public MustInherit Class CloudAdapterBase
Inherits BotAdapter

Inheritance: Object

BotAdapter
CloudAdapterBase

Derived: Microsoft.Bot.Builder.Integration.AspNet.Core.CloudAdapter

Constructors

CloudAdapterBase(BotFrameworkAuthentication, ILogger)

Initializes a new instance of the CloudAdapterBase 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

BotFrameworkAuthentication	Gets the BotFrameworkAuthentication instance for this adapter.
Logger	Gets a ILogger to use within this adapter and its subclasses.
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)

Methods

ContinueConversationAsync(ClaimsIdentity, Activity, BotCallbackHandler, CancellationToken)	Sends a proactive message to a conversation.
ContinueConversationAsync(ClaimsIdentity, Activity, String, BotCallbackHandler, CancellationToken)	Sends a proactive message to a conversation.
ContinueConversationAsync(ClaimsIdentity, ConversationReference, BotCallbackHandler, CancellationToken)	Sends a proactive message from the bot to a conversation.
ContinueConversationAsync(ClaimsIdentity, ConversationReference, String, BotCallbackHandler, CancellationToken)	Sends a proactive message from the bot to a conversation.
ContinueConversationAsync(String, Activity, BotCallbackHandler, CancellationToken)	Sends a proactive message to a conversation.
ContinueConversationAsync(String, ConversationReference, BotCallbackHandler, CancellationToken)	Sends a proactive message from the bot to a conversation.
CreateClaimsIdentity(String)	This is a helper to create the ClaimsIdentity structure from an appId that will be added to the TurnContext. It is intended for use in proactive and named-pipe scenarios.
CreateConversationAsync(String, String, String, String, ConversationParameters, BotCallbackHandler, CancellationToken)	Creates a conversation on the specified channel.
DeleteActivityAsync(ITurnContext, ConversationReference, CancellationToken)	When overridden in a derived class, deletes an existing activity in the conversation.
GetStreamingConnectorFactory(Activity)	Gets the correct streaming connector factory that is processing the given activity.
ProcessActivityAsync(AuthenticateRequestResult, Activity, BotCallbackHandler, CancellationToken)	The implementation for processing an Activity sent to this bot.
ProcessActivityAsync(ClaimsIdentity, Activity, BotCallbackHandler, CancellationToken)	Creates a turn context and runs the middleware pipeline for an incoming TRUSTED activity. (Inherited from BotAdapter)
ProcessActivityAsync(String, Activity, BotCallbackHandler, CancellationToken)	The implementation for processing an Activity sent to this bot.
ProcessProactiveAsync(ClaimsIdentity, Activity, String, BotCallbackHandler, CancellationToken)	The implementation for continue conversation.
RunPipelineAsync(ITurnContext, BotCallbackHandler, CancellationToken)	Starts activity processing for the current bot turn. (Inherited from BotAdapter)
SendActivitiesAsync(ITurnContext, Activity[], CancellationToken)	When overridden in a derived class, sends activities to the conversation.
UpdateActivityAsync(ITurnContext, Activity, CancellationToken)	When overridden in a derived class, replaces an existing activity in the conversation.
Use(IMiddleware)	Adds middleware to the adapter's pipeline. (Inherited from BotAdapter)

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