Activity class

Creates a new Activity instance.

new Activity(t: string)

Parameters

The action associated with the activity.

action?: string

Property Value

The attachment layout of the activity.

attachmentLayout?: string

Property Value

The attachments of the activity.

attachments?: Attachment[]

Property Value

The caller ID of the activity.

callerId?: string

Property Value

The channel-specific data for the activity.

channelData?: any

Property Value

Return the combined channel:subChannel value like agent:email

undefined | string channelId

Property Value

Returns the primary channel ID for the activity.

undefined | string channelIdChannel

Property Value

Returns the sub-channel ID for the activity.

unknown channelIdSubChannel

Property Value

The end-of-conversation code for the activity.

code?: string

Property Value

The conversation account associated with the activity.

conversation?: ConversationAccount

Property Value

The delivery mode of the activity.

deliveryMode?: string

Property Value

The entities associated with the activity.

entities?: Entity[]

Property Value

The expiration time of the activity.

expiration?: string | Date

Property Value

The account of the sender of the activity.

from?: ChannelAccount

Property Value

Indicates whether the history is disclosed.

historyDisclosed?: boolean

Property Value

The unique identifier of the activity.

id?: string

Property Value

The importance of the activity.

importance?: string

Property Value

The input hint for the activity.

inputHint?: string

Property Value

The label for the activity.

label?: string

Property Value

The list of keywords to listen for in the activity.

listenFor?: string[]

Property Value

The locale of the activity.

locale?: string

Property Value

The local timestamp of the activity.

localTimestamp?: string | Date

Property Value

The local timezone of the activity.

localTimezone?: string

Property Value

The members added to the conversation.

membersAdded?: ChannelAccount[]

Property Value

The members removed from the conversation.

membersRemoved?: ChannelAccount[]

Property Value

The name of the activity event.

name?: string

Property Value

The raw expiration time of the activity.

rawExpiration?: string

Property Value

The raw local timestamp of the activity.

rawLocalTimestamp?: string

Property Value

The raw timestamp of the activity.

rawTimestamp?: string

Property Value

The reactions added to the activity.

reactionsAdded?: MessageReaction[]

Property Value

The reactions removed from the activity.

reactionsRemoved?: MessageReaction[]

Property Value

The recipient of the activity.

recipient?: ChannelAccount

Property Value

The conversation reference for the activity.

relatesTo?: ConversationReference

Property Value

The ID of the activity being replied to.

replyToId?: string

Property Value

The semantic action associated with the activity.

semanticAction?: SemanticAction

Property Value

The service URL of the activity.

serviceUrl?: string

Property Value

The speech text of the activity.

speak?: string

Property Value

The suggested actions for the activity.

suggestedActions?: SuggestedActions

Property Value

The summary of the activity.

summary?: string

Property Value

The text content of the activity.

text?: string

Property Value

The text format of the activity.

textFormat?: string

Property Value

The text highlights in the activity.

textHighlights?: TextHighlight[]

Property Value

The timestamp of the activity.

timestamp?: string | Date

Property Value

The topic name of the activity.

topicName?: string

Property Value

The type of the activity.

type: string

Property Value

The value associated with the activity.

value?: unknown

Property Value

The value type of the activity.

valueType?: string

Property Value

Applies a conversation reference to the activity.

function applyConversationReference(reference: ConversationReference, isIncoming?: boolean): Activity

Parameters

Returns

The updated activity.

function clone(): Activity

Returns

Creates an Activity instance from a JSON string.

static function fromJson(json: string): Activity

Parameters

Returns

The created Activity instance.

Creates an Activity instance from an object.

static function fromObject(o: object): Activity

Parameters

Returns

The created Activity instance.

Gets the agent instance ID from the context if its agentic

function getAgenticInstanceId(): undefined | string

Returns

agent instance id as string

Retrieves the tenant ID associated with the agentic recipient of the activity, if available; otherwise, returns the tenant ID from the conversation.

function getAgenticTenantId(): undefined | string

Returns

The tenant ID of the agentic recipient if present; otherwise, the tenant ID from the conversation. Returns undefined if neither is available.

Gets the agentic user (UPN) from the context if it's an agentic request.

function getAgenticUser(): undefined | string

Returns

Creates a continuation activity from a conversation reference.

static function getContinuationActivity(reference: ConversationReference): Activity

Parameters

Returns

The created continuation activity.

Gets the conversation reference for the activity.

function getConversationReference(): ConversationReference

Returns

The conversation reference.

Gets the mentions in the activity.

function getMentions(activity: Activity): Mention[]

Parameters

Returns

The list of mentions.

Gets the conversation reference for a reply.

function getReplyConversationReference(replyId: string): ConversationReference

Parameters

Returns

The conversation reference.

Does this activity represent an agentic request?

function isAgenticRequest(): boolean

Returns

True if agentic

Normalizes mentions in the activity by removing mention tags and optionally removing recipient mention.

function normalizeMentions(removeMention?: boolean)

Parameters

Given a composite channelId like agent:email, return the channel and subChannel.

static function parseChannelId(value: string): [undefined | string, undefined | string]

Parameters

Returns

[channel, subChannel]

Removes the mention text for a given ID.

function removeMentionText(id: string): string

Parameters

Returns

The updated text.

Removes the recipient mention from the activity text.

function removeRecipientMention(): string

Returns

The updated text.

Converts the activity to a JSON string.

function toJsonString(replacer?: (this: any, key: string, value: any) => any, space?: string | number): string

Parameters

Returns

The JSON string representation of the activity.