Documentation - v1.2.0-alpha.3
    Preparing search index...

    Class Activity

    Represents an activity in a conversation.

    Indexable

    • [x: string]: unknown

      Additional properties of the activity.

    Index

    Constructors

    constructor

    Properties

    _channelId? action? attachmentLayout? attachments? callerId? channelData? code? conversation? deliveryMode? entities? expiration? from? historyDisclosed? id? importance? inputHint? label? listenFor? locale? localTimestamp? localTimezone? membersAdded? membersRemoved? name? rawExpiration? rawLocalTimestamp? rawTimestamp? reactionsAdded? reactionsRemoved? recipient? relatesTo? replyToId? semanticAction? serviceUrl? speak? suggestedActions? summary? text? textFormat? textHighlights? timestamp? topicName? type value? valueType?

    Accessors

    channelId channelIdChannel channelIdSubChannel

    Methods

    applyConversationReference clone getAgenticInstanceId getAgenticTenantId getAgenticUser getConversationReference getMentions getReplyConversationReference isAgenticRequest normalizeMentions removeMentionText removeRecipientMention toJsonString fromJson fromObject getContinuationActivity parseChannelId

    Constructors

    Properties

    Optional_channelId

    _channelId?: string

    The primary channel ID where the activity originated.

    action?: string

    The action associated with the activity.

    attachmentLayout?: string

    The attachment layout of the activity.

    attachments?: Attachment[]

    The attachments of the activity.

    callerId?: string

    The caller ID of the activity.

    channelData?: any

    The channel-specific data for the activity.

    code?: string

    The end-of-conversation code for the activity.

    conversation?: ConversationAccount

    The conversation account associated with the activity.

    deliveryMode?: string

    The delivery mode of the activity.

    entities?: Entity[]

    The entities associated with the activity.

    expiration?: string | Date

    The expiration time of the activity.

    from?: ChannelAccount

    The account of the sender of the activity.

    historyDisclosed?: boolean

    Indicates whether the history is disclosed.

    id?: string

    The unique identifier of the activity.

    importance?: string

    The importance of the activity.

    inputHint?: string

    The input hint for the activity.

    label?: string

    The label for the activity.

    listenFor?: string[]

    The list of keywords to listen for in the activity.

    locale?: string

    The locale of the activity.

    localTimestamp?: string | Date

    The local timestamp of the activity.

    localTimezone?: string

    The local timezone of the activity.

    membersAdded?: ChannelAccount[]

    The members added to the conversation.

    membersRemoved?: ChannelAccount[]

    The members removed from the conversation.

    name?: string

    The name of the activity event.

    rawExpiration?: string

    The raw expiration time of the activity.

    rawLocalTimestamp?: string

    The raw local timestamp of the activity.

    rawTimestamp?: string

    The raw timestamp of the activity.

    reactionsAdded?: MessageReaction[]

    The reactions added to the activity.

    reactionsRemoved?: MessageReaction[]

    The reactions removed from the activity.

    recipient?: ChannelAccount

    The recipient of the activity.

    relatesTo?: ConversationReference

    The conversation reference for the activity.

    replyToId?: string

    The ID of the activity being replied to.

    semanticAction?: SemanticAction

    The semantic action associated with the activity.

    serviceUrl?: string

    The service URL of the activity.

    speak?: string

    The speech text of the activity.

    suggestedActions?: SuggestedActions

    The suggested actions for the activity.

    summary?: string

    The summary of the activity.

    Optionaltext

    text?: string

    The text content of the activity.

    textFormat?: string

    The text format of the activity.

    textHighlights?: TextHighlight[]

    The text highlights in the activity.

    timestamp?: string | Date

    The timestamp of the activity.

    topicName?: string

    The topic name of the activity.

    type: string

    The type of the activity.

    value?: unknown

    The value associated with the activity.

    valueType?: string

    The value type of the activity.

    Accessors

    Methods

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

      Returns string | undefined

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

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

      Parameters

      • removeMention: boolean = false

        Whether to remove the recipient mention from the activity.

      Returns void

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

      Parameters

      • value: string

      Returns [string | undefined, string | undefined]

      [channel, subChannel]

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods