IEvent interface
An event received from or being sent to a source.
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'. |
reply |
The ID of the event this update is related to. |
source | The original source of the event (i.e. 'facebook', 'skype', 'slack', etc.) |
source |
The original event in the sources native schema. For outgoing messages can be used to pass source specific event data like custom attachments. |
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
agent
SDK thats processing the event. Will always be 'botbuilder'.
agent: string
Property Value
string
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
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