IStartConversationAddress interface

Package:

botbuilder

Additional properties that can be passed in with the address to UniversalBot.beginDialog().

Extends

IChatConnectorAddress

Properties

activity	(Optional) when creating a new conversation, use this activity as the initial message to the conversation.
bot	Bot that either received or is sending the message.
channelData	(Optional) channel specific payload for creating the conversation.
channelId	Unique identifier for channel.
conversation	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.
id	Incoming Message ID.
isGroup	(Optional) if true the conversation should be a group conversation.
members	(Optional) members to add to the conversation. If missing, the conversation will be started with the user.
serviceUrl	Specifies the URL to post messages back.
topicName	(Optional) topic of the conversation (if supported by the channel)
user	User that sent or should receive the message.

Property Details

activity

(Optional) when creating a new conversation, use this activity as the initial message to the conversation.

activity?: any

Property Value

any

bot

Bot that either received or is sending the message.

bot: IIdentity

Property Value

IIdentity

channelData

(Optional) channel specific payload for creating the conversation.

channelData?: any

Property Value

any

channelId

Unique identifier for channel.

channelId: string

Property Value

string

conversation

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.

conversation?: IIdentity

Property Value

IIdentity

id

Incoming Message ID.

id?: string

Property Value

string

isGroup

(Optional) if true the conversation should be a group conversation.

isGroup?: boolean

Property Value

boolean

members

(Optional) members to add to the conversation. If missing, the conversation will be started with the user.

members?: IIdentity[]

Property Value

IIdentity[]

serviceUrl

Specifies the URL to post messages back.

serviceUrl?: string

Property Value

string

topicName

(Optional) topic of the conversation (if supported by the channel)

topicName?: string

Property Value

string

user

User that sent or should receive the message.

user: IIdentity

Property Value

IIdentity