-
Notifications
You must be signed in to change notification settings - Fork 16
/
SkillConversationIdFactoryBase.yml
135 lines (133 loc) · 4.93 KB
/
SkillConversationIdFactoryBase.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
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
### YamlMime:TSType
name: SkillConversationIdFactoryBase
uid: botbuilder-core.SkillConversationIdFactoryBase
package: botbuilder-core
summary: >-
Defines the methods of a factory that is used to create unique conversation
IDs for skill conversations.
fullName: SkillConversationIdFactoryBase
remarks: ''
isPreview: false
isDeprecated: false
type: class
methods:
- name: createSkillConversationId(ConversationReference)
uid: botbuilder-core.SkillConversationIdFactoryBase.createSkillConversationId
package: botbuilder-core
summary: >-
Creates a conversation ID for a skill conversation based on the caller's
ConversationReference.
remarks: >-
It should be possible to use the returned string on a request URL and it
should not contain special characters.
Returns A unique conversation ID used to communicate with the skill.
isPreview: false
isDeprecated: true
customDeprecatedMessage: >-
Method is deprecated, please use createSkillConversationIdWithOptions()
with SkillConversationIdFactoryOptions instead.
syntax:
content: >-
function createSkillConversationId(_conversationReference:
ConversationReference): Promise<string>
parameters:
- id: _conversationReference
type: ConversationReference
description: The skill's caller ConversationReference.
return:
description: ''
type: Promise<string>
- name: createSkillConversationIdWithOptions(SkillConversationIdFactoryOptions)
uid: >-
botbuilder-core.SkillConversationIdFactoryBase.createSkillConversationIdWithOptions
package: botbuilder-core
summary: >-
Creates a conversation ID for a skill conversation based on the caller's
ConversationReference.
remarks: >-
It should be possible to use the returned string on a request URL and it
should not contain special characters.
Returns A unique conversation ID used to communicate with the skill.
isPreview: false
isDeprecated: false
syntax:
content: >-
function createSkillConversationIdWithOptions(_options:
SkillConversationIdFactoryOptions): Promise<string>
parameters:
- id: _options
type: <xref uid="botbuilder-core.SkillConversationIdFactoryOptions" />
description: >-
The
[SkillConversationIdFactoryOptions](xref:botbuilder-core.SkillConversationIdFactoryOptions)
to use.
return:
description: ''
type: Promise<string>
- name: deleteConversationReference(string)
uid: botbuilder-core.SkillConversationIdFactoryBase.deleteConversationReference
package: botbuilder-core
summary: Deletes a ConversationReference.
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: >-
function deleteConversationReference(skillConversationId: string):
Promise<void>
parameters:
- id: skillConversationId
type: string
description: |
A skill conversationId created using createSkillConversationId().
return:
description: ''
type: Promise<void>
- name: getConversationReference(string)
uid: botbuilder-core.SkillConversationIdFactoryBase.getConversationReference
package: botbuilder-core
summary: >-
Gets the ConversationReference created using createSkillConversationId()
for a skillConversationId.
remarks: >-
Returns The caller's ConversationReference for a skillConversationId. null
if not found.
isPreview: false
isDeprecated: true
customDeprecatedMessage: 'Method is deprecated, please use getSkillConversationReference() instead.'
syntax:
content: >-
function getConversationReference(_skillConversationId: string):
Promise<ConversationReference>
parameters:
- id: _skillConversationId
type: string
description: A skill conversationId created using createSkillConversationId().
return:
description: ''
type: Promise<ConversationReference>
- name: getSkillConversationReference(string)
uid: >-
botbuilder-core.SkillConversationIdFactoryBase.getSkillConversationReference
package: botbuilder-core
summary: >-
Gets the SkillConversationReference created using
createSkillConversationId() for a skillConversationId.
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: >-
function getSkillConversationReference(_skillConversationId: string):
Promise<SkillConversationReference>
parameters:
- id: _skillConversationId
type: string
description: >
Gets the SkillConversationReference used during
createSkillConversationId for a skillConversationId.
return:
description: ''
type: >-
Promise<<xref uid="botbuilder-core.SkillConversationReference"
/>>