IChannelAdapter Interface

Definition

Namespace:: Microsoft.Agents.Builder

Assembly:: Microsoft.Agents.Builder.dll

Package:: Microsoft.Agents.Builder v1.2.41

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.

Represents an Adapter that can connect an Agent to a service endpoint.

public interface IChannelAdapter

type IChannelAdapter = interface

Public Interface IChannelAdapter

Derived: Microsoft.Agents.Builder.ChannelAdapter

Remarks

The Adapter encapsulates processing a received Activity, creates an ITurnContext and calls OnTurnAsync(ITurnContext, CancellationToken). When your Agent receives an activity, response are sent to the caller via SendActivityAsync(IActivity, CancellationToken).

Properties

MiddlewareSet	Gets the collection of middleware in the Adapter's pipeline.
OnTurnError	Gets or sets an error handler that can catch exceptions in the middleware or application.

Methods

ContinueConversationAsync(ClaimsIdentity, ConversationReference, AgentCallbackHandler, CancellationToken)	Continues a conversation in a new Turn. This is typically used for proactive interactions.
ContinueConversationAsync(ClaimsIdentity, ConversationReference, String, AgentCallbackHandler, CancellationToken)	Continues a conversation in a new Turn. This is typically used for proactive interactions.
ContinueConversationAsync(ClaimsIdentity, IActivity, AgentCallbackHandler, CancellationToken)	Sends a proactive message to a conversation. See ProcessProactiveAsync(ClaimsIdentity, IActivity, String, AgentCallbackHandler, CancellationToken).
ContinueConversationAsync(ClaimsIdentity, IActivity, String, AgentCallbackHandler, CancellationToken)	Continues a conversation in a new Turn. This is typically used for proactive interactions.
ContinueConversationAsync(String, ConversationReference, AgentCallbackHandler, CancellationToken)	Continues a conversation in a new Turn. This is typically used for proactive interactions.
ContinueConversationAsync(String, IActivity, AgentCallbackHandler, CancellationToken)	Continues a conversation in a new Turn. This is typically used for proactive interactions.
CreateConversationAsync(String, String, String, String, ConversationParameters, AgentCallbackHandler, CancellationToken)	Creates a conversation on the specified channel and executes a turn with the proper context for the new conversation.
DeleteActivityAsync(ITurnContext, ConversationReference, CancellationToken)	When overridden in a derived class, deletes an existing activity in the conversation.
ProcessActivityAsync(ClaimsIdentity, IActivity, AgentCallbackHandler, CancellationToken)	Creates a turn context and runs the middleware pipeline for an incoming TRUSTED activity.
ProcessProactiveAsync(ClaimsIdentity, IActivity, IAgent, CancellationToken, String)
ProcessProactiveAsync(ClaimsIdentity, IActivity, String, AgentCallbackHandler, CancellationToken)	Executes a new turn pipeline in the context of the conversation of an Activity.
SendActivitiesAsync(ITurnContext, IActivity[], CancellationToken)	When overridden in a derived class, sends activities to the conversation.
UpdateActivityAsync(ITurnContext, IActivity, CancellationToken)	When overridden in a derived class, replaces an existing activity in the conversation.
Use(IMiddleware)	Adds middleware to the adapter's pipeline.

Applies to

Feedback

Was this page helpful?

Share via