Class BaseAdapter`Abstract`

Abstract base class for all adapters in the Agents framework.

Remarks

This class provides core functionality for handling conversations, managing middleware, authentication, and error handling. Adapters are responsible for translating between the Agents framework and specific communication channels (like Teams, Web Chat, etc.).

Key features:

Middleware pipeline for processing incoming and outgoing activities
Error handling and recovery mechanisms
Authentication provider integration
Abstract methods for channel-specific operations
Context management with revocable proxies for security

Hierarchy (View Summary)

BaseAdapter
- CloudAdapter

Index

Constructors

constructor

new BaseAdapter(): BaseAdapter
Returns BaseAdapter

Properties

`Readonly`ConnectorClientKey

ConnectorClientKey: symbol = ...

Symbol key used to store connector client instances in the TurnContext.

`Protected`middleware

middleware: MiddlewareSet = ...

The middleware set used to process the pipeline of middleware handlers.

`Readonly`UserTokenClientKey

UserTokenClientKey: symbol = ...

Symbol key used to store User Token Client instances in the TurnContext.

Accessors

onTurnError

get onTurnError(): (context: TurnContext, error: Error) => Promise<void>
Gets the error handler for the adapter.

Returns (context: TurnContext, error: Error) => Promise<void>
The current error handler function.
- Defined in packages/agents-hosting/src/baseAdapter.ts:130
set onTurnError(
value: (context: TurnContext, error: Error) => Promise<void>,
): void
Sets the error handler for the adapter.
Parameters
- value: (context: TurnContext, error: Error) => Promise<void>
  The error handler function to set.
Returns void
- Defined in packages/agents-hosting/src/baseAdapter.ts:138

Methods

`Abstract`continueConversation

continueConversation(
    botAppIdOrIdentity: string | JwtPayload,
    reference: Partial<ConversationReference>,
    logic: (revocableContext: TurnContext) => Promise<void>,
): Promise<void>
Continues a conversation.
Parameters
- botAppIdOrIdentity: string | JwtPayload
- reference: Partial<ConversationReference>
  The conversation reference to continue.
- logic: (revocableContext: TurnContext) => Promise<void>
  The logic to execute.
Returns Promise<void>
A promise representing the completion of the continue operation.
- Defined in packages/agents-hosting/src/baseAdapter.ts:94

`Abstract`deleteActivity

deleteActivity(
context: TurnContext,
reference: Partial<ConversationReference>,
): Promise<void>
Deletes an existing activity.
Parameters
- context: TurnContext
  The TurnContext for the current turn.
- reference: Partial<ConversationReference>
  The conversation reference of the activity to delete.
Returns Promise<void>
A promise representing the completion of the delete operation.
- Defined in packages/agents-hosting/src/baseAdapter.ts:86

`Abstract`getAttachment

getAttachment(
    context: TurnContext,
    attachmentId: string,
    viewId: string,
): Promise<ReadableStream>
Parameters
- context: TurnContext
- attachmentId: string
  The attachment ID.
- viewId: string
  The view ID.
Returns Promise<ReadableStream>
A promise representing the NodeJS.ReadableStream for the requested attachment.

Deprecated
This function will not be supported in future versions. Use TurnContext.turnState.get(CloudAdapter.ConnectorClientKey). Gets an attachment.
- Defined in packages/agents-hosting/src/baseAdapter.ts:124

`Abstract`getAttachmentInfo

getAttachmentInfo(
context: TurnContext,
attachmentId: string,
): Promise<AttachmentInfo>
Parameters
- context: TurnContext
- attachmentId: string
  The attachment ID.
Returns Promise<AttachmentInfo>
A promise representing the AttachmentInfo for the requested attachment.

Deprecated
This function will not be supported in future versions. Use TurnContext.turnState.get(CloudAdapter.ConnectorClientKey). Gets attachment information.
- Defined in packages/agents-hosting/src/baseAdapter.ts:115

`Protected`runMiddleware

runMiddleware(
context: TurnContext,
next: (revocableContext: TurnContext) => Promise<void>,
): Promise<void>
Runs the middleware pipeline in sequence.
Parameters
- context: TurnContext
  The TurnContext for the current turn.
- next: (revocableContext: TurnContext) => Promise<void>
  The next function to call in the pipeline.
Returns Promise<void>
A promise representing the completion of the middleware pipeline.
- Defined in packages/agents-hosting/src/baseAdapter.ts:187

`Abstract`sendActivities

sendActivities(
context: TurnContext,
activities: Activity[],
): Promise<ResourceResponse[]>
Sends a set of activities to the conversation.
Parameters
- context: TurnContext
  The TurnContext for the current turn.
- activities: Activity[]
  The activities to send.
Returns Promise<ResourceResponse[]>
A promise representing the array of ResourceResponses for the sent activities.
- Defined in packages/agents-hosting/src/baseAdapter.ts:70

`Abstract`updateActivity

updateActivity(
context: TurnContext,
activity: Activity,
): Promise<void | ResourceResponse>
Updates an existing activity.
Parameters
- context: TurnContext
  The TurnContext for the current turn.
- activity: Activity
  The activity to update.
Returns Promise<void | ResourceResponse>
A promise representing the ResourceResponse for the updated activity.
- Defined in packages/agents-hosting/src/baseAdapter.ts:78

`Abstract`uploadAttachment

uploadAttachment(
    context: TurnContext,
    conversationId: string,
    attachmentData: AttachmentData,
): Promise<ResourceResponse>
Parameters
- context: TurnContext
- conversationId: string
  The conversation ID.
- attachmentData: AttachmentData
  The attachment data.
Returns Promise<ResourceResponse>
A promise representing the ResourceResponse for the uploaded attachment.

Deprecated
This function will not be supported in future versions. Use TurnContext.turnState.get(CloudAdapter.ConnectorClientKey). Uploads an attachment.
- Defined in packages/agents-hosting/src/baseAdapter.ts:107

use

use(...middlewares: (Middleware | MiddlewareHandler)[]): this
Adds middleware to the adapter's middleware pipeline.
Parameters
- ...middlewares: (Middleware | MiddlewareHandler)[]
  The middleware to add.
Returns this
The adapter instance.
- Defined in packages/agents-hosting/src/baseAdapter.ts:147

Class BaseAdapterAbstract

Remarks

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Returns BaseAdapter

Properties

ReadonlyConnectorClientKey

Protectedmiddleware

ReadonlyUserTokenClientKey

Accessors

onTurnError

Returns (context: TurnContext, error: Error) => Promise<void>

Parameters

Returns void

Methods

AbstractcontinueConversation

Parameters

Returns Promise<void>

AbstractdeleteActivity

Parameters

Returns Promise<void>

AbstractgetAttachment

Parameters

Returns Promise<ReadableStream>

Deprecated

AbstractgetAttachmentInfo

Parameters

Returns Promise<AttachmentInfo>

Deprecated

ProtectedrunMiddleware

Parameters

Returns Promise<void>

AbstractsendActivities

Parameters

Returns Promise<ResourceResponse[]>

AbstractupdateActivity

Parameters

Returns Promise<void | ResourceResponse>

AbstractuploadAttachment

Parameters

Returns Promise<ResourceResponse>

Deprecated

use

Parameters

Returns this

Settings

On This Page

Class BaseAdapter`Abstract`

`Readonly`ConnectorClientKey

`Protected`middleware

`Readonly`UserTokenClientKey

`Abstract`continueConversation

`Abstract`deleteActivity

`Abstract`getAttachment

`Abstract`getAttachmentInfo

`Protected`runMiddleware

`Abstract`sendActivities

`Abstract`updateActivity

`Abstract`uploadAttachment