-
Notifications
You must be signed in to change notification settings - Fork 16
/
index.yml
203 lines (203 loc) · 6.77 KB
/
index.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
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
### YamlMime:TSPackage
uid: botbuilder
name: botbuilder
summary: ''
type: package
functions:
- name: validateAndFixActivity(Activity)
uid: botbuilder.validateAndFixActivity
package: botbuilder
summary: >-
Validates an [Activity](xref:botbuilder-core.Activity) and formats the
timestamp fields.
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: 'function validateAndFixActivity(activity: Activity): Activity'
parameters:
- id: activity
type: Activity
description: '(xref:botbuilder-core.Activity) to be validated.'
return:
description: 'The [Activity](xref:botframework-schema.Activity).'
type: Activity
- name: teamsGetChannelId(Activity)
uid: botbuilder.teamsGetChannelId
package: botbuilder
summary: Activity helper methods for Teams.
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: 'function teamsGetChannelId(activity: Activity): string | null'
parameters:
- id: activity
type: Activity
description: 'The current [Activity](xref:botframework-schema.Activity).'
return:
description: >-
The current [Activity](xref:botframework-schema.Activity)'s team's
channel id, or null.
type: string | null
- name: teamsGetSelectedChannelId(Activity)
uid: botbuilder.teamsGetSelectedChannelId
package: botbuilder
summary: Gets the Team's selected channel id from the current activity.
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: 'function teamsGetSelectedChannelId(activity: Activity): string'
parameters:
- id: activity
type: Activity
description: 'The current [Activity](xref:botframework-schema.Activity).'
return:
description: 'The current activity''s team''s selected channel, or empty string.'
type: string
- name: teamsGetTeamId(Activity)
uid: botbuilder.teamsGetTeamId
package: botbuilder
summary: >-
Gets the Team Id from the current
[Activity](xref:botframework-schema.Activity).
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: 'function teamsGetTeamId(activity: Activity): string | null'
parameters:
- id: activity
type: Activity
description: 'The current [Activity](xref:botframework-schema.Activity).'
return:
description: >-
The current [Activity](xref:botframework-schema.Activity)'s team's Id,
or null.
type: string | null
- name: teamsGetTeamInfo(Activity)
uid: botbuilder.teamsGetTeamInfo
package: botbuilder
summary: >-
Gets the TeamsInfo object from the current
[Activity](xref:botframework-schema.Activity).
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: 'function teamsGetTeamInfo(activity: Activity): TeamInfo | null'
parameters:
- id: activity
type: Activity
description: 'The current [Activity](xref:botframework-schema.Activity).'
return:
description: >-
The current [Activity](xref:botframework-schema.Activity)'s team's
info, or null.
type: TeamInfo | null
- name: teamsGetTeamMeetingInfo(Activity)
uid: botbuilder.teamsGetTeamMeetingInfo
package: botbuilder
summary: >-
Gets the TeamsMeetingInfo object from the current
[Activity](xref:botframework-schema.Activity).
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: >-
function teamsGetTeamMeetingInfo(activity: Activity): TeamsMeetingInfo |
null
parameters:
- id: activity
type: Activity
description: 'The current [Activity](xref:botframework-schema.Activity).'
return:
description: >-
The current [Activity](xref:botframework-schema.Activity)'s team
meeting info, or null.
type: TeamsMeetingInfo | null
- name: teamsGetTenant(Activity)
uid: botbuilder.teamsGetTenant
package: botbuilder
summary: >-
Gets the TenantInfo object from the current
[Activity](xref:botframework-schema.Activity).
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: 'function teamsGetTenant(activity: Activity): TenantInfo | null'
parameters:
- id: activity
type: Activity
description: 'The current [Activity](xref:botframework-schema.Activity).'
return:
description: >-
The current [Activity](xref:botframework-schema.Activity)'s tenant
info, or null.
type: TenantInfo | null
- name: 'teamsNotifyUser(Partial<Activity>, boolean, string)'
uid: botbuilder.teamsNotifyUser
package: botbuilder
summary: >-
Configures the current [Activity](xref:botframework-schema.Activity) to
generate a notification within Teams.
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: >-
function teamsNotifyUser(activity: Partial<Activity>, alertInMeeting?:
boolean, externalResourceUrl?: string)
parameters:
- id: activity
type: Partial<Activity>
description: 'The current [Activity](xref:botframework-schema.Activity).'
- id: alertInMeeting
type: boolean
description: >-
Sent to a meeting chat, this will cause the Teams client to render
it in a notification popup as well as in the chat thread.
- id: externalResourceUrl
type: string
description: >
Url to external resource. Must be included in manifest's valid
domains.
classes:
- botbuilder.BotFrameworkAdapter
- botbuilder.BotFrameworkHttpClient
- botbuilder.ChannelServiceHandler
- botbuilder.ChannelServiceHandlerBase
- botbuilder.ChannelServiceRoutes
- botbuilder.CloudAdapter
- botbuilder.CloudChannelServiceHandler
- botbuilder.EventFactory
- botbuilder.FileTranscriptStore
- botbuilder.HandoffEventNames
- botbuilder.InspectionMiddleware
- botbuilder.InspectionState
- botbuilder.RouteConstants
- botbuilder.SetSpeakMiddleware
- botbuilder.CloudSkillHandler
- botbuilder.SkillHandler
- botbuilder.SkillHandlerImpl
- botbuilder.SkillHttpClient
- botbuilder.StatusCodeError
- botbuilder.StreamingHttpClient
- botbuilder.TokenResolver
- botbuilder.TeamsSSOTokenExchangeMiddleware
- botbuilder.TeamsActivityHandler
- botbuilder.TeamsInfo
interfaces:
- botbuilder.BotFrameworkAdapterSettings
- botbuilder.BotFrameworkHttpAdapter
- botbuilder.WebServer
- botbuilder.ConnectorClientBuilder
- botbuilder.Request
- botbuilder.Response
- botbuilder.WebRequest
- botbuilder.WebResponse
typeAliases:
- botbuilder.RouteHandler