Edit

Share via

ConversationParameters interface

  • Reference
Package:
botframework-schema

Parameters for creating a new conversation

Properties

activity

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

The bot address for this conversation
channelData

Channel specific payload for creating the conversation
isGroup

IsGroup
members

Members to add to the conversation
tenantId

(Optional) The tenant ID in which the conversation should be created
topicName

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

Property Details

activity

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

activity: Activity

Property Value

Activity

bot

The bot address for this conversation

bot: ChannelAccount

Property Value

ChannelAccount

channelData

Channel specific payload for creating the conversation

channelData: any

Property Value

any

isGroup

IsGroup

isGroup: boolean

Property Value

boolean

members

Members to add to the conversation

members?: ChannelAccount[]

Property Value

ChannelAccount[]

tenantId

(Optional) The tenant ID in which the conversation should be created

tenantId?: string

Property Value

string

topicName

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

topicName?: string

Property Value

string