IMessageActivity interface

Package:

botframework-schema

Extends

IActivity

Properties

attachmentLayout	The layout hint for multiple attachments. Default: list. Possible values include: 'list', 'carousel'
attachments	Attachments
deliveryMode	A delivery hint to signal to the recipient alternate delivery paths for the activity. The default delivery mode is "default". Possible values include: 'normal', 'notification'
expiration	The time at which the activity should be considered to be "expired" and should not be presented to the recipient.
importance	The importance of the activity. Possible values include: 'low', 'normal', 'high'
inputHint	Indicates whether your bot is accepting, expecting, or ignoring user input after the message is delivered to the client. Possible values include: 'acceptingInput', 'ignoringInput', 'expectingInput'
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.
speak	The text to speak.
suggestedActions	The suggested actions for the activity.
summary	The text to display if the channel cannot render cards.
text	The text content of the message.
textFormat	Format of text fields Default:markdown. Possible values include: 'markdown', 'plain', 'xml'
value	A value that is associated with the activity.

Inherited Properties

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.
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.
recipient	Identifies the recipient of the message.
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.
timestamp	Contains the date and time that the message was sent, in UTC, expressed in ISO-8601 format.
type	Contains the activity type 'iActivity'

Property Details

attachmentLayout

The layout hint for multiple attachments. Default: list. Possible values include: 'list', 'carousel'

attachmentLayout?: AttachmentLayoutTypes | string

Property Value

AttachmentLayoutTypes | string

attachments

Attachments

attachments?: Attachment[]

Property Value

Attachment[]

deliveryMode

A delivery hint to signal to the recipient alternate delivery paths for the activity. The default delivery mode is "default". Possible values include: 'normal', 'notification'

deliveryMode?: DeliveryModes | string

Property Value

DeliveryModes | string

expiration

The time at which the activity should be considered to be "expired" and should not be presented to the recipient.

expiration?: Date

Property Value

Date

importance

The importance of the activity. Possible values include: 'low', 'normal', 'high'

importance?: ActivityImportance | string

Property Value

ActivityImportance | string

inputHint

Indicates whether your bot is accepting, expecting, or ignoring user input after the message is delivered to the client. Possible values include: 'acceptingInput', 'ignoringInput', 'expectingInput'

inputHint?: InputHints | string

Property Value

InputHints | 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

speak

The text to speak.

speak?: string

Property Value

string

suggestedActions

The suggested actions for the activity.

suggestedActions?: SuggestedActions

Property Value

SuggestedActions

summary

The text to display if the channel cannot render cards.

summary?: string

Property Value

string

text

The text content of the message.

text: string

Property Value

string

textFormat

Format of text fields Default:markdown. Possible values include: 'markdown', 'plain', 'xml'

textFormat?: TextFormatTypes | string

Property Value

TextFormatTypes | string

value

A value that is associated with the activity.

value?: any

Property Value

any

Inherited Property Details

channelData

Contains channel-specific content.

channelData?: any

Property Value

any

Inherited From IActivity.channelData

channelId

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

channelId: string

Property Value

string

Inherited From IActivity.channelId

conversation

Identifies the conversation to which the activity belongs.

conversation: ConversationAccount

Property Value

ConversationAccount

Inherited From IActivity.conversation

entities

Represents the entities that were mentioned in the message.

entities?: Entity[]

Property Value

Entity[]

Inherited From IActivity.entities

from

Identifies the sender of the message.

from: ChannelAccount

Property Value

ChannelAccount

Inherited From IActivity.from

id

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

id?: string

Property Value

string

Inherited From IActivity.id

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

Inherited From IActivity.localTimestamp

recipient

Identifies the recipient of the message.

recipient: ChannelAccount

Property Value

ChannelAccount

Inherited From IActivity.recipient

replyToId

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

replyToId?: string

Property Value

string

Inherited From IActivity.replyToId

serviceUrl

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

serviceUrl: string

Property Value

string

Inherited From IActivity.serviceUrl

timestamp

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

timestamp?: Date

Property Value

Date

Inherited From IActivity.timestamp

type

Contains the activity type 'iActivity'

type: ActivityTypes | string

Property Value

ActivityTypes | string

Inherited From IActivity.type