Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface IAddress

Address routing information for an event. Addresses are bidirectional meaning they can be used to address both incoming and outgoing events. They're also connector specific meaning that connectors are free to add their own fields to the address.

To send a proactive message to a user bots should save the address from a received message. Depending on the channel addresses can change, so bots should periodically update the address stored for a given user.

Hierarchy

  • IAddress

Index

Properties

bot

Bot that either received or is sending the message.

channelId

channelId: string

Unique identifier for channel.

Optional conversation

conversation: IIdentity

Represents the current conversation and tracks where replies should be routed to. Can be deleted to start a new conversation with a user on channels that support new conversations.

user

user: IIdentity

User that sent or should receive the message.

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