Edit

Share via

IEndOfConversationActivity interface

  • Reference
Package:
botframework-schema
Extends
IActivity

Properties

code

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

The text content of the message.

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

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

text

The text content of the message.

text: string

Property Value

string

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