Class TeamsActivityBuilder

Fluent builder for constructing outbound TeamsActivity instances.

Example

const reply = new TeamsActivityBuilder()
  .withConversationReference(incomingActivity)
  .withText('Hello!')
  .addMention(activity.from)
  .build()

Index

Constructors

constructor

Methods

withConversationReference withType withServiceUrl withConversation withFrom withRecipient withText withChannelData withSuggestedActions withEntities withAttachments withAttachment addEntity addAttachment addMention addAdaptiveCardAttachment withAdaptiveCardAttachment build

Constructors

constructor

new TeamsActivityBuilder(): TeamsActivityBuilder
Returns TeamsActivityBuilder

Methods

withConversationReference

withConversationReference(source: CoreActivity): this
Copy routing fields from an incoming activity and swap from/recipient.
Parameters
- source: CoreActivity
  The incoming activity to copy routing fields from.
Returns this
this for method chaining.
- Defined in packages/botas-core/src/teams-activity.ts:105

withType

withType(type: string): this
Set the activity type (default is "message").
Parameters
- type: string
  Activity type string.
Returns this
this for method chaining.
- Defined in packages/botas-core/src/teams-activity.ts:119

withServiceUrl

withServiceUrl(serviceUrl: string): this
Set the service URL.
Parameters
- serviceUrl: string
  Bot Service service URL for the channel.
Returns this
this for method chaining.
- Defined in packages/botas-core/src/teams-activity.ts:130

withConversation

withConversation(conversation: Conversation): this
Set the conversation.
Parameters
- conversation: Conversation
  Conversation reference.
Returns this
this for method chaining.
- Defined in packages/botas-core/src/teams-activity.ts:141

withFrom

withFrom(from: ChannelAccount): this
Set the sender account.
Parameters
- from: ChannelAccount
  Sender's channel account.
Returns this
this for method chaining.
- Defined in packages/botas-core/src/teams-activity.ts:152

withRecipient

withRecipient(recipient: ChannelAccount): this
Set the recipient account.
Parameters
- recipient: ChannelAccount
  Recipient's channel account.
Returns this
this for method chaining.
- Defined in packages/botas-core/src/teams-activity.ts:163

withText

withText(text: string): this
Set the text content.
Parameters
- text: string
  Message text.
Returns this
this for method chaining.
- Defined in packages/botas-core/src/teams-activity.ts:174

withChannelData

withChannelData(channelData?: TeamsChannelData): this
Set the Teams-specific channel data.
Parameters
- OptionalchannelData: TeamsChannelData
  Teams channel data (tenant, team, channel info, etc.).
Returns this
this for method chaining.
- Defined in packages/botas-core/src/teams-activity.ts:185

withSuggestedActions

withSuggestedActions(suggestedActions?: SuggestedActions): this
Set the suggested actions.
Parameters
- OptionalsuggestedActions: SuggestedActions
  Quick-reply buttons to display below the message.
Returns this
this for method chaining.
- Defined in packages/botas-core/src/teams-activity.ts:196

withEntities

withEntities(entities?: Entity[]): this
Replace the entities array.
Parameters
- Optionalentities: Entity[]
  New entities array, or undefined to clear.
Returns this
this for method chaining.
- Defined in packages/botas-core/src/teams-activity.ts:207

withAttachments

withAttachments(attachments?: Attachment[]): this
Replace the attachments array.
Parameters
- Optionalattachments: Attachment[]
  New attachments array, or undefined to clear.
Returns this
this for method chaining.
- Defined in packages/botas-core/src/teams-activity.ts:218

withAttachment

withAttachment(attachment: Attachment): this
Set a single attachment (replaces the collection).
Parameters
- attachment: Attachment
  The attachment to set.
Returns this
this for method chaining.
- Defined in packages/botas-core/src/teams-activity.ts:229

addEntity

addEntity(entity: Entity): this
Append an entity to the collection.
Parameters
- entity: Entity
  Entity to add.
Returns this
this for method chaining.
- Defined in packages/botas-core/src/teams-activity.ts:240

addAttachment

addAttachment(attachment: Attachment): this
Append an attachment to the collection.
Parameters
- attachment: Attachment
  Attachment to add.
Returns this
this for method chaining.
- Defined in packages/botas-core/src/teams-activity.ts:252

addMention

addMention(account: ChannelAccount, mentionText?: string): this
Creates a mention entity for the account and adds it to entities. Does NOT modify the activity text — caller must include <at>Name</at> markup.
Parameters
- account: ChannelAccount
  The channel account to mention.
- OptionalmentionText: string
  Optional custom mention text; defaults to <at>account.name</at>.
Returns this
this for method chaining.

Throws
If account is falsy.
- Defined in packages/botas-core/src/teams-activity.ts:267

addAdaptiveCardAttachment

addAdaptiveCardAttachment(card: string | Record<string, unknown>): this
Parses JSON string or accepts a pre-parsed object as an Adaptive Card and appends it as an attachment.
Parameters
- card: string | Record<string, unknown>
  JSON string or pre-parsed Adaptive Card object.
Returns this
this for method chaining.

Throws
If card is a string and not valid JSON.
- Defined in packages/botas-core/src/teams-activity.ts:285

withAdaptiveCardAttachment

withAdaptiveCardAttachment(card: string | Record<string, unknown>): this
Parses JSON string or accepts a pre-parsed object as an Adaptive Card and sets it as the only attachment.
Parameters
- card: string | Record<string, unknown>
  JSON string or pre-parsed Adaptive Card object.
Returns this
this for method chaining.

Throws
If card is a string and not valid JSON.
- Defined in packages/botas-core/src/teams-activity.ts:301

build

build(): Partial<TeamsActivity>
Return the constructed TeamsActivity.

Returns Partial<TeamsActivity>
A shallow copy of the activity built so far.
- Defined in packages/botas-core/src/teams-activity.ts:315

Class TeamsActivityBuilder

Example

Index

Constructors

Methods

Constructors

constructor

Returns TeamsActivityBuilder

Methods

withConversationReference

Parameters

Returns this

withType

Parameters

Returns this

withServiceUrl

Parameters

Returns this

withConversation

Parameters

Returns this

withFrom

Parameters

Returns this

withRecipient

Parameters

Returns this

withText

Parameters

Returns this

withChannelData

Parameters

Returns this

withSuggestedActions

Parameters

Returns this

withEntities

Parameters

Returns this

withAttachments

Parameters

Returns this

withAttachment

Parameters

Returns this

addEntity

Parameters

Returns this

addAttachment

Parameters

Returns this

addMention

Parameters

Returns this

Throws

addAdaptiveCardAttachment

Parameters

Returns this

Throws

withAdaptiveCardAttachment

Parameters

Returns this

Throws

build

Returns Partial<TeamsActivity>

Settings

On This Page