IActivity interface

Package:

@microsoft/teams.api

Properties

channel	Information about the channel in which the message was sent.
channelData	Contains channel-specific content.
channelId	Contains an ID that uniquely identifies the channel. Set by the channel.
conversation	Identifies the conversation to which the activity belongs.
entities	Represents the entities that were mentioned in the message.
from	Identifies the sender of the message.
id	Contains an ID that uniquely identifies the activity on the channel.
locale	A locale name for the contents of the text field. The locale name is a combination of an ISO 639 two- or three-letter culture code associated with a language and an ISO 3166 two-letter subculture code associated with a country or region. The locale name can also correspond to a valid BCP-47 language tag.
localTimestamp	Contains the local date and time of the message, expressed in ISO-8601 format. For example, 2016-09-23T13:07:49.4714686-07:00.
meeting	Information about the tenant in which the message was sent.
notification	Notification settings for the message.
recipient	Identifies the recipient of the message.
relatesTo	A reference to another conversation or activity.
replyToId	Contains the ID of the message to which this message is a reply.
serviceUrl	Contains the URL that specifies the channel's service endpoint. Set by the channel.
team	Information about the team in which the message was sent.
timestamp	Contains the date and time that the message was sent, in UTC, expressed in ISO-8601 format.
type	Contains the type of the activity.

Methods

isStreaming()

is this a streaming activity

Property Details

channel

Information about the channel in which the message was sent.

undefined | ChannelInfo channel

Property Value

undefined | ChannelInfo

channelData

Contains channel-specific content.

channelData?: ChannelData

Property Value

ChannelData

channelId

Contains an ID that uniquely identifies the channel. Set by the channel.

channelId: ChannelID

Property Value

ChannelID

conversation

Identifies the conversation to which the activity belongs.

conversation: ConversationAccount

Property Value

ConversationAccount

entities

Represents the entities that were mentioned in the message.

entities?: Entity[]

Property Value

Entity[]

from

Identifies the sender of the message.

from: Account<any>

Property Value

Account<any>

id

Contains an ID that uniquely identifies the activity on the channel.

id: string

Property Value

string

locale

A locale name for the contents of the text field. The locale name is a combination of an ISO 639 two- or three-letter culture code associated with a language and an ISO 3166 two-letter subculture code associated with a country or region. The locale name can also correspond to a valid BCP-47 language tag.

locale?: string

Property Value

string

localTimestamp

Contains the local date and time of the message, expressed in ISO-8601 format.

For example, 2016-09-23T13:07:49.4714686-07:00.

localTimestamp?: Date

Property Value

Date

meeting

Information about the tenant in which the message was sent.

undefined | MeetingInfo meeting

Property Value

undefined | MeetingInfo

notification

Notification settings for the message.

undefined | NotificationInfo notification

Property Value

undefined | NotificationInfo

recipient

Identifies the recipient of the message.

recipient: Account<any>

Property Value

Account<any>

relatesTo

A reference to another conversation or activity.

relatesTo?: ConversationReference

Property Value

ConversationReference

replyToId

Contains the ID of the message to which this message is a reply.

replyToId?: string

Property Value

string

serviceUrl

Contains the URL that specifies the channel's service endpoint. Set by the channel.

serviceUrl?: string

Property Value

string

team

Information about the team in which the message was sent.

undefined | TeamInfo team

Property Value

undefined | TeamInfo

timestamp

Contains the date and time that the message was sent, in UTC, expressed in ISO-8601 format.

timestamp?: Date

Property Value

Date

type

Contains the type of the activity.

type: T

Property Value

T

Method Details

isStreaming()

is this a streaming activity

function isStreaming(): boolean

Returns

boolean