/
ConversationParameters.yml
106 lines (105 loc) · 2.96 KB
/
ConversationParameters.yml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
### YamlMime:TSType
name: ConversationParameters
uid: botframework-schema.ConversationParameters
package: botframework-schema
summary: Parameters for creating a new conversation
fullName: ConversationParameters
remarks: ''
isPreview: false
isDeprecated: false
type: interface
properties:
- name: activity
uid: botframework-schema.ConversationParameters.activity
package: botframework-schema
summary: >-
(Optional) When creating a new conversation, use this activity as the
initial message to the
conversation
fullName: activity
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: 'activity: Activity'
return:
description: ''
type: <xref uid="botframework-schema.Activity" />
- name: bot
uid: botframework-schema.ConversationParameters.bot
package: botframework-schema
summary: The bot address for this conversation
fullName: bot
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: 'bot: ChannelAccount'
return:
description: ''
type: <xref uid="botframework-schema.ChannelAccount" />
- name: channelData
uid: botframework-schema.ConversationParameters.channelData
package: botframework-schema
summary: Channel specific payload for creating the conversation
fullName: channelData
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: 'channelData: any'
return:
description: ''
type: any
- name: isGroup
uid: botframework-schema.ConversationParameters.isGroup
package: botframework-schema
summary: IsGroup
fullName: isGroup
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: 'isGroup: boolean'
return:
description: ''
type: boolean
- name: members
uid: botframework-schema.ConversationParameters.members
package: botframework-schema
summary: Members to add to the conversation
fullName: members
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: 'members?: ChannelAccount[]'
return:
description: ''
type: '<xref uid="botframework-schema.ChannelAccount" />[]'
- name: tenantId
uid: botframework-schema.ConversationParameters.tenantId
package: botframework-schema
summary: (Optional) The tenant ID in which the conversation should be created
fullName: tenantId
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: 'tenantId?: string'
return:
description: ''
type: string
- name: topicName
uid: botframework-schema.ConversationParameters.topicName
package: botframework-schema
summary: (Optional) Topic of the conversation (if supported by the channel)
fullName: topicName
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: 'topicName?: string'
return:
description: ''
type: string