Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface IConversationUpdate

The Properties of a conversation have changed.

example

bot.on('conversationUpdate', function (update) {
    // ... process update ...
});

Hierarchy

Index

Properties

address

address: IAddress

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

agent

agent: string

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

Optional historyDisclosed

historyDisclosed: boolean

If true then history was disclosed.

Optional membersAdded

membersAdded: IIdentity[]

Array of members added to the conversation.

Optional membersRemoved

membersRemoved: IIdentity[]

Array of members removed from the conversation.

source

source: string

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

sourceEvent

sourceEvent: any

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

Optional topicName

topicName: string

The conversations new topic name.

type

type: string

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

user

user: IIdentity

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.

Legend

  • Module
  • Object literal
  • Variable
  • Function
  • Function with type parameter
  • Index signature
  • Type alias
  • Enumeration
  • Enumeration member
  • Property
  • Method
  • Interface
  • Interface with type parameter
  • Constructor
  • Property
  • Method
  • Index signature
  • Class
  • Class with type parameter
  • Constructor
  • Property
  • Method
  • Accessor
  • Index signature
  • Inherited constructor
  • Inherited property
  • Inherited method
  • Inherited accessor
  • Protected property
  • Protected method
  • Protected accessor
  • Private property
  • Private method
  • Private accessor
  • Static property
  • Static method