IConversationUpdate interface

Package:

botbuilder

The Properties of a conversation have changed.

Extends

IEvent

Properties

address	Address routing information for the event. Save this field to external storage somewhere to later compose a proactive message to the user.
agent	SDK thats processing the event. Will always be 'botbuilder'.
historyDisclosed	If true then history was disclosed.
membersAdded	Array of members added to the conversation.
membersRemoved	Array of members removed from the conversation.
reactionsAdded	Array of reactions added to an activity.
reactionsRemoved	Array of reactions removed from an activity.
replyToId	The ID of the event this update is related to.
source	The original source of the event (i.e. 'facebook', 'skype', 'slack', etc.)
sourceEvent	The original event in the sources native schema. For outgoing messages can be used to pass source specific event data like custom attachments.
topicName	The conversations new topic name.
type	Defines type of event. Should be 'message' for an IMessage.
user	For incoming messages this is the user that sent the message. By default this is a copy of address.user but you can configure your bot with a lookupUser function that lets map the incoming user to an internal user id.

Property Details

address

Address routing information for the event. Save this field to external storage somewhere to later compose a proactive message to the user.

address: IAddress

Property Value

IAddress

agent

SDK thats processing the event. Will always be 'botbuilder'.

agent: string

Property Value

string

historyDisclosed

If true then history was disclosed.

historyDisclosed?: boolean

Property Value

boolean

membersAdded

Array of members added to the conversation.

membersAdded?: IIdentity[]

Property Value

IIdentity[]

membersRemoved

Array of members removed from the conversation.

membersRemoved?: IIdentity[]

Property Value

IIdentity[]

reactionsAdded

Array of reactions added to an activity.

reactionsAdded?: IMessageReaction[]

Property Value

IMessageReaction[]

reactionsRemoved

Array of reactions removed from an activity.

reactionsRemoved?: IMessageReaction[]

Property Value

IMessageReaction[]

replyToId

The ID of the event this update is related to.

replyToId?: string

Property Value

string

source

The original source of the event (i.e. 'facebook', 'skype', 'slack', etc.)

source: string

Property Value

string

sourceEvent

The original event in the sources native schema. For outgoing messages can be used to pass source specific event data like custom attachments.

sourceEvent: any

Property Value

any

topicName

The conversations new topic name.

topicName?: string

Property Value

string

type

Defines type of event. Should be 'message' for an IMessage.

type: string

Property Value

string

user

For incoming messages this is the user that sent the message. By default this is a copy of address.user but you can configure your bot with a lookupUser function that lets map the incoming user to an internal user id.

user: IIdentity

Property Value

IIdentity