WebexAdapter Class

Reference

Definition

Namespace:: Microsoft.Bot.Builder.Adapters.Webex

Assembly:: Microsoft.Bot.Builder.Adapters.Webex.dll

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

Caution

The Bot Framework Adapters will be deprecated in the next version of the Bot Framework SDK and moved to https://github.com/BotBuilderCommunity/botbuilder-community-dotnet. Please refer to their new location for all future work.

BotAdapter to allow for handling Webex Teams app payloads and responses via the Webex Teams API.

[System.Obsolete("The Bot Framework Adapters will be deprecated in the next version of the Bot Framework SDK and moved to https://github.com/BotBuilderCommunity/botbuilder-community-dotnet. Please refer to their new location for all future work.")]
public class WebexAdapter : Microsoft.Bot.Builder.BotAdapter, Microsoft.Bot.Builder.Integration.AspNet.Core.IBotFrameworkHttpAdapter

[<System.Obsolete("The Bot Framework Adapters will be deprecated in the next version of the Bot Framework SDK and moved to https://github.com/BotBuilderCommunity/botbuilder-community-dotnet. Please refer to their new location for all future work.")>]
type WebexAdapter = class
    inherit BotAdapter
    interface IBotFrameworkHttpAdapter

Public Class WebexAdapter
Inherits BotAdapter
Implements IBotFrameworkHttpAdapter

Inheritance: Object

BotAdapter
WebexAdapter

Attributes: ObsoleteAttribute

Implements: IBotFrameworkHttpAdapter

Constructors

WebexAdapter(IConfiguration, WebexAdapterOptions, ILogger)	Initializes a new instance of the WebexAdapter class using configuration settings.
WebexAdapter(WebexClientWrapper, WebexAdapterOptions, ILogger)	Initializes a new instance of the WebexAdapter class. Creates a Webex adapter.

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

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. (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.
ContinueConversationAsync(ClaimsIdentity, ConversationReference, String, BotCallbackHandler, CancellationToken)	Sends a proactive message to a conversation. (Inherited from BotAdapter)
ContinueConversationAsync(ConversationReference, BotCallbackHandler, CancellationToken)	Standard BotBuilder adapter method for continuing an existing conversation based on a conversation reference.
ContinueConversationAsync(String, Activity, BotCallbackHandler, CancellationToken)	Sends a proactive message to a conversation. (Inherited from BotAdapter)
ContinueConversationAsync(String, ConversationReference, BotCallbackHandler, CancellationToken)	Sends a proactive message to a conversation. (Inherited from BotAdapter)
CreateConversationAsync(String, String, String, String, ConversationParameters, BotCallbackHandler, CancellationToken)	Creates a conversation on the specified channel. (Inherited from BotAdapter)
DeleteActivityAsync(ITurnContext, ConversationReference, CancellationToken)	Standard BotBuilder adapter method to delete a previous message.
ProcessActivityAsync(ClaimsIdentity, Activity, BotCallbackHandler, CancellationToken)	Creates a turn context and runs the middleware pipeline for an incoming TRUSTED activity. (Inherited from BotAdapter)
ProcessAsync(HttpRequest, HttpResponse, IBot, CancellationToken)	Accept an incoming webhook HttpRequest and convert it into a TurnContext which can be processed by the bot's logic.
RunPipelineAsync(ITurnContext, BotCallbackHandler, CancellationToken)	Starts activity processing for the current bot turn. (Inherited from BotAdapter)
SendActivitiesAsync(ITurnContext, Activity[], CancellationToken)	Standard BotBuilder adapter method to send a message from the bot to the messaging API.
UpdateActivityAsync(ITurnContext, Activity, CancellationToken)	Standard BotBuilder adapter method to update a previous message.
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