ActivityTimestamps interface

Package:

botframework-schema

This interface is used to preserve the original string values of dates on Activities. When an Activity is received, timestamps are converted to Dates. Due to how Javascript Date objects are UTC, timezone offset values are lost.

Extends

Activity

Properties

rawExpiration
rawLocalTimestamp
rawTimestamp

Inherited Properties

action	Indicates whether the recipient of a contactRelationUpdate was added or removed from the sender's contact list.
attachmentLayout	The layout hint for multiple attachments. Default: list. Possible values include: 'list', 'carousel'
attachments	Attachments
callerId	A string containing a URI identifying the caller of a bot. This field is not intended to be transmitted over the wire, but is instead populated by bots and clients based on cryptographically verifiable data that asserts the identity of the callers (e.g. tokens).
channelData	Contains channel-specific content.
channelId	Contains an ID that uniquely identifies the channel. Set by the channel.
code	The a code for endOfConversation activities that indicates why the conversation ended. Possible values include: 'unknown', 'completedSuccessfully', 'userCancelled', 'botTimedOut', 'botIssuedInvalidMessage', 'channelFailed'
conversation	Identifies the conversation to which the activity belongs.
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', 'expectReplies', 'ephemeral'
entities	Represents the entities that were mentioned in the message.
expiration	The time at which the activity should be considered to be "expired" and should not be presented to the recipient.
from	Identifies the sender of the message.
historyDisclosed	Indicates whether the prior history of the channel is disclosed.
id	Contains an ID that uniquely identifies the activity on the channel.
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'
label	A descriptive label for the activity.
listenFor	List of phrases and references that speech and language priming systems should listen for
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.
localTimezone	Contains the name of the local timezone of the message, expressed in IANA Time Zone database format. For example, America/Los_Angeles.
membersAdded	The collection of members added to the conversation.
membersRemoved	The collection of members removed from the conversation.
name	The name of the operation associated with an invoke or event activity.
reactionsAdded	The collection of reactions added to the conversation.
reactionsRemoved	The collection of reactions removed from the conversation.
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.
semanticAction	An optional programmatic action accompanying this request
serviceUrl	Contains the URL that specifies the channel's service endpoint. Set by the channel.
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'
textHighlights	The collection of text fragments to highlight when the activity contains a ReplyToId value.
timestamp	Contains the date and time that the message was sent, in UTC, expressed in ISO-8601 format.
topicName	The updated topic name of the conversation.
type	Contains the activity type. Possible values include: 'message', 'contactRelationUpdate', 'conversationUpdate', 'typing', 'endOfConversation', 'event', 'invoke', 'deleteUserData', 'messageUpdate', 'messageDelete', 'installationUpdate', 'messageReaction', 'suggestion', 'trace', 'handoff'
value	A value that is associated with the activity.
valueType	The type of the activity's value object.

Property Details

rawExpiration

rawExpiration?: string

Property Value

string

rawLocalTimestamp

rawLocalTimestamp?: string

Property Value

string

rawTimestamp

rawTimestamp?: string

Property Value

string

Inherited Property Details

action

Indicates whether the recipient of a contactRelationUpdate was added or removed from the sender's contact list.

action?: string

Property Value

string

Inherited From Activity.action

attachmentLayout

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

attachmentLayout?: AttachmentLayoutTypes | string

Property Value

AttachmentLayoutTypes | string

Inherited From Activity.attachmentLayout

attachments

Attachments

attachments?: Attachment[]

Property Value

Attachment[]

Inherited From Activity.attachments

callerId

A string containing a URI identifying the caller of a bot. This field is not intended to be transmitted over the wire, but is instead populated by bots and clients based on cryptographically verifiable data that asserts the identity of the callers (e.g. tokens).

callerId: string

Property Value

string

Inherited From Activity.callerId

channelData

Contains channel-specific content.

channelData?: any

Property Value

any

Inherited From Activity.channelData

channelId

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

channelId: string

Property Value

string

Inherited From Activity.channelId

code

The a code for endOfConversation activities that indicates why the conversation ended. Possible values include: 'unknown', 'completedSuccessfully', 'userCancelled', 'botTimedOut', 'botIssuedInvalidMessage', 'channelFailed'

code?: EndOfConversationCodes | string

Property Value

EndOfConversationCodes | string

Inherited From Activity.code

conversation

Identifies the conversation to which the activity belongs.

conversation: ConversationAccount

Property Value

ConversationAccount

Inherited From Activity.conversation

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', 'expectReplies', 'ephemeral'

deliveryMode?: DeliveryModes | string

Property Value

DeliveryModes | string

Inherited From Activity.deliveryMode

entities

Represents the entities that were mentioned in the message.

entities?: Entity[]

Property Value

Entity[]

Inherited From Activity.entities

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

Inherited From Activity.expiration

from

Identifies the sender of the message.

from: ChannelAccount

Property Value

ChannelAccount

Inherited From Activity.from

historyDisclosed

Indicates whether the prior history of the channel is disclosed.

historyDisclosed?: boolean

Property Value

boolean

Inherited From Activity.historyDisclosed

id

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

id?: string

Property Value

string

Inherited From Activity.id

importance

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

importance?: ActivityImportance | string

Property Value

ActivityImportance | string

Inherited From Activity.importance

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

Inherited From Activity.inputHint

label

A descriptive label for the activity.

label: string

Property Value

string

Inherited From Activity.label

listenFor

List of phrases and references that speech and language priming systems should listen for

listenFor: string[]

Property Value

string[]

Inherited From Activity.listenFor

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

Inherited From Activity.locale

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 Activity.localTimestamp

localTimezone

Contains the name of the local timezone of the message, expressed in IANA Time Zone database format. For example, America/Los_Angeles.

localTimezone: string

Property Value

string

Inherited From Activity.localTimezone

membersAdded

The collection of members added to the conversation.

membersAdded?: ChannelAccount[]

Property Value

ChannelAccount[]

Inherited From Activity.membersAdded

membersRemoved

The collection of members removed from the conversation.

membersRemoved?: ChannelAccount[]

Property Value

ChannelAccount[]

Inherited From Activity.membersRemoved

name

The name of the operation associated with an invoke or event activity.

name?: ActivityEventNames | string

Property Value

ActivityEventNames | string

Inherited From Activity.name

reactionsAdded

The collection of reactions added to the conversation.

reactionsAdded?: MessageReaction[]

Property Value

MessageReaction[]

Inherited From Activity.reactionsAdded

reactionsRemoved

The collection of reactions removed from the conversation.

reactionsRemoved?: MessageReaction[]

Property Value

MessageReaction[]

Inherited From Activity.reactionsRemoved

recipient

Identifies the recipient of the message.

recipient: ChannelAccount

Property Value

ChannelAccount

Inherited From Activity.recipient

relatesTo

A reference to another conversation or activity.

relatesTo?: ConversationReference

Property Value

ConversationReference

Inherited From Activity.relatesTo

replyToId

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

replyToId?: string

Property Value

string

Inherited From Activity.replyToId

semanticAction

An optional programmatic action accompanying this request

semanticAction?: SemanticAction

Property Value

SemanticAction

Inherited From Activity.semanticAction

serviceUrl

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

serviceUrl: string

Property Value

string

Inherited From Activity.serviceUrl

speak

The text to speak.

speak?: string

Property Value

string

Inherited From Activity.speak

suggestedActions

The suggested actions for the activity.

suggestedActions?: SuggestedActions

Property Value

SuggestedActions

Inherited From Activity.suggestedActions

summary

The text to display if the channel cannot render cards.

summary?: string

Property Value

string

Inherited From Activity.summary

text

The text content of the message.

text: string

Property Value

string

Inherited From Activity.text

textFormat

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

textFormat?: TextFormatTypes | string

Property Value

TextFormatTypes | string

Inherited From Activity.textFormat

textHighlights

The collection of text fragments to highlight when the activity contains a ReplyToId value.

textHighlights?: TextHighlight[]

Property Value

TextHighlight[]

Inherited From Activity.textHighlights

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 Activity.timestamp

topicName

The updated topic name of the conversation.

topicName?: string

Property Value

string

Inherited From Activity.topicName

type

Contains the activity type. Possible values include: 'message', 'contactRelationUpdate', 'conversationUpdate', 'typing', 'endOfConversation', 'event', 'invoke', 'deleteUserData', 'messageUpdate', 'messageDelete', 'installationUpdate', 'messageReaction', 'suggestion', 'trace', 'handoff'

type: ActivityTypes | string

Property Value

ActivityTypes | string

Inherited From Activity.type

value

A value that is associated with the activity.

value?: any

Property Value

any

Inherited From Activity.value

valueType

The type of the activity's value object.

valueType: string

Property Value

string

Inherited From Activity.valueType