-
Notifications
You must be signed in to change notification settings - Fork 16
/
Activity.yml
637 lines (618 loc) · 18.3 KB
/
Activity.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
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
### YamlMime:TSType
name: Activity
uid: botframework-schema.Activity
package: botframework-schema
summary: >-
An Activity is the basic communication type for the Bot Framework 3.0
protocol.
fullName: Activity
remarks: ''
isPreview: false
isDeprecated: false
type: interface
properties:
- name: action
uid: botframework-schema.Activity.action
package: botframework-schema
summary: >-
Indicates whether the recipient of a contactRelationUpdate was added or
removed from the
sender's contact list.
fullName: action
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: 'action?: string'
return:
description: ''
type: string
- name: attachmentLayout
uid: botframework-schema.Activity.attachmentLayout
package: botframework-schema
summary: >-
The layout hint for multiple attachments. Default: list. Possible values
include: 'list',
'carousel'
fullName: attachmentLayout
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: 'attachmentLayout?: AttachmentLayoutTypes | string'
return:
description: ''
type: <xref uid="botframework-schema.AttachmentLayoutTypes" /> | string
- name: attachments
uid: botframework-schema.Activity.attachments
package: botframework-schema
summary: Attachments
fullName: attachments
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: 'attachments?: Attachment[]'
return:
description: ''
type: '<xref uid="botframework-schema.Attachment" />[]'
- name: callerId
uid: botframework-schema.Activity.callerId
package: botframework-schema
summary: >-
A string containing a URI identifying the caller of a bot. This field is
not intended to be transmitted over
the wire, but is instead populated by bots and clients based on
cryptographically verifiable data that asserts
the identity of the callers (e.g. tokens).
fullName: callerId
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: 'callerId: string'
return:
description: ''
type: string
- name: channelData
uid: botframework-schema.Activity.channelData
package: botframework-schema
summary: Contains channel-specific content.
fullName: channelData
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: 'channelData?: any'
return:
description: ''
type: any
- name: channelId
uid: botframework-schema.Activity.channelId
package: botframework-schema
summary: Contains an ID that uniquely identifies the channel. Set by the channel.
fullName: channelId
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: 'channelId: string'
return:
description: ''
type: string
- name: code
uid: botframework-schema.Activity.code
package: botframework-schema
summary: >-
The a code for endOfConversation activities that indicates why the
conversation ended.
Possible values include: 'unknown', 'completedSuccessfully',
'userCancelled', 'botTimedOut',
'botIssuedInvalidMessage', 'channelFailed'
fullName: code
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: 'code?: EndOfConversationCodes | string'
return:
description: ''
type: <xref uid="botframework-schema.EndOfConversationCodes" /> | string
- name: conversation
uid: botframework-schema.Activity.conversation
package: botframework-schema
summary: Identifies the conversation to which the activity belongs.
fullName: conversation
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: 'conversation: ConversationAccount'
return:
description: ''
type: <xref uid="botframework-schema.ConversationAccount" />
- name: deliveryMode
uid: botframework-schema.Activity.deliveryMode
package: botframework-schema
summary: >-
A delivery hint to signal to the recipient alternate delivery paths for
the activity.
The default delivery mode is "default". Possible values include: 'normal',
'notification', 'expectReplies', 'ephemeral'
fullName: deliveryMode
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: 'deliveryMode?: DeliveryModes | string'
return:
description: ''
type: <xref uid="botframework-schema.DeliveryModes" /> | string
- name: entities
uid: botframework-schema.Activity.entities
package: botframework-schema
summary: Represents the entities that were mentioned in the message.
fullName: entities
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: 'entities?: Entity[]'
return:
description: ''
type: '<xref uid="botframework-schema.Entity" />[]'
- name: expiration
uid: botframework-schema.Activity.expiration
package: botframework-schema
summary: >-
The time at which the activity should be considered to be "expired" and
should not be
presented to the recipient.
fullName: expiration
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: 'expiration?: Date'
return:
description: ''
type: Date
- name: from
uid: botframework-schema.Activity.from
package: botframework-schema
summary: Identifies the sender of the message.
fullName: from
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: 'from: ChannelAccount'
return:
description: ''
type: <xref uid="botframework-schema.ChannelAccount" />
- name: historyDisclosed
uid: botframework-schema.Activity.historyDisclosed
package: botframework-schema
summary: Indicates whether the prior history of the channel is disclosed.
fullName: historyDisclosed
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: 'historyDisclosed?: boolean'
return:
description: ''
type: boolean
- name: id
uid: botframework-schema.Activity.id
package: botframework-schema
summary: Contains an ID that uniquely identifies the activity on the channel.
fullName: id
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: 'id?: string'
return:
description: ''
type: string
- name: importance
uid: botframework-schema.Activity.importance
package: botframework-schema
summary: >-
The importance of the activity. Possible values include: 'low', 'normal',
'high'
fullName: importance
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: 'importance?: ActivityImportance | string'
return:
description: ''
type: <xref uid="botframework-schema.ActivityImportance" /> | string
- name: inputHint
uid: botframework-schema.Activity.inputHint
package: botframework-schema
summary: >-
Indicates whether your bot is accepting,
expecting, or ignoring user input after the message is delivered to the
client. Possible
values include: 'acceptingInput', 'ignoringInput', 'expectingInput'
fullName: inputHint
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: 'inputHint?: InputHints | string'
return:
description: ''
type: <xref uid="botframework-schema.InputHints" /> | string
- name: label
uid: botframework-schema.Activity.label
package: botframework-schema
summary: A descriptive label for the activity.
fullName: label
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: 'label: string'
return:
description: ''
type: string
- name: listenFor
uid: botframework-schema.Activity.listenFor
package: botframework-schema
summary: >-
List of phrases and references that speech and language priming systems
should listen for
fullName: listenFor
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: 'listenFor: string[]'
return:
description: ''
type: 'string[]'
- name: locale
uid: botframework-schema.Activity.locale
package: botframework-schema
summary: >-
A locale name for the contents of the text field.
The locale name is a combination of an ISO 639 two- or three-letter
culture code associated
with a language
and an ISO 3166 two-letter subculture code associated with a country or
region.
The locale name can also correspond to a valid BCP-47 language tag.
fullName: locale
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: 'locale?: string'
return:
description: ''
type: string
- name: localTimestamp
uid: botframework-schema.Activity.localTimestamp
package: botframework-schema
summary: >-
Contains the local date and time of the message, expressed in ISO-8601
format.
For example, 2016-09-23T13:07:49.4714686-07:00.
fullName: localTimestamp
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: 'localTimestamp?: Date'
return:
description: ''
type: Date
- name: localTimezone
uid: botframework-schema.Activity.localTimezone
package: botframework-schema
summary: >-
Contains the name of the local timezone of the message, expressed in IANA
Time Zone database format.
For example, America/Los_Angeles.
fullName: localTimezone
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: 'localTimezone: string'
return:
description: ''
type: string
- name: membersAdded
uid: botframework-schema.Activity.membersAdded
package: botframework-schema
summary: The collection of members added to the conversation.
fullName: membersAdded
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: 'membersAdded?: ChannelAccount[]'
return:
description: ''
type: '<xref uid="botframework-schema.ChannelAccount" />[]'
- name: membersRemoved
uid: botframework-schema.Activity.membersRemoved
package: botframework-schema
summary: The collection of members removed from the conversation.
fullName: membersRemoved
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: 'membersRemoved?: ChannelAccount[]'
return:
description: ''
type: '<xref uid="botframework-schema.ChannelAccount" />[]'
- name: name
uid: botframework-schema.Activity.name
package: botframework-schema
summary: The name of the operation associated with an invoke or event activity.
fullName: name
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: 'name?: ActivityEventNames | string'
return:
description: ''
type: <xref uid="botframework-schema.ActivityEventNames" /> | string
- name: reactionsAdded
uid: botframework-schema.Activity.reactionsAdded
package: botframework-schema
summary: The collection of reactions added to the conversation.
fullName: reactionsAdded
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: 'reactionsAdded?: MessageReaction[]'
return:
description: ''
type: '<xref uid="botframework-schema.MessageReaction" />[]'
- name: reactionsRemoved
uid: botframework-schema.Activity.reactionsRemoved
package: botframework-schema
summary: The collection of reactions removed from the conversation.
fullName: reactionsRemoved
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: 'reactionsRemoved?: MessageReaction[]'
return:
description: ''
type: '<xref uid="botframework-schema.MessageReaction" />[]'
- name: recipient
uid: botframework-schema.Activity.recipient
package: botframework-schema
summary: Identifies the recipient of the message.
fullName: recipient
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: 'recipient: ChannelAccount'
return:
description: ''
type: <xref uid="botframework-schema.ChannelAccount" />
- name: relatesTo
uid: botframework-schema.Activity.relatesTo
package: botframework-schema
summary: A reference to another conversation or activity.
fullName: relatesTo
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: 'relatesTo?: ConversationReference'
return:
description: ''
type: <xref uid="botframework-schema.ConversationReference" />
- name: replyToId
uid: botframework-schema.Activity.replyToId
package: botframework-schema
summary: Contains the ID of the message to which this message is a reply.
fullName: replyToId
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: 'replyToId?: string'
return:
description: ''
type: string
- name: semanticAction
uid: botframework-schema.Activity.semanticAction
package: botframework-schema
summary: An optional programmatic action accompanying this request
fullName: semanticAction
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: 'semanticAction?: SemanticAction'
return:
description: ''
type: <xref uid="botframework-schema.SemanticAction" />
- name: serviceUrl
uid: botframework-schema.Activity.serviceUrl
package: botframework-schema
summary: >-
Contains the URL that specifies the channel's service endpoint. Set by the
channel.
fullName: serviceUrl
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: 'serviceUrl: string'
return:
description: ''
type: string
- name: speak
uid: botframework-schema.Activity.speak
package: botframework-schema
summary: The text to speak.
fullName: speak
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: 'speak?: string'
return:
description: ''
type: string
- name: suggestedActions
uid: botframework-schema.Activity.suggestedActions
package: botframework-schema
summary: The suggested actions for the activity.
fullName: suggestedActions
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: 'suggestedActions?: SuggestedActions'
return:
description: ''
type: <xref uid="botframework-schema.SuggestedActions" />
- name: summary
uid: botframework-schema.Activity.summary
package: botframework-schema
summary: The text to display if the channel cannot render cards.
fullName: summary
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: 'summary?: string'
return:
description: ''
type: string
- name: text
uid: botframework-schema.Activity.text
package: botframework-schema
summary: The text content of the message.
fullName: text
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: 'text: string'
return:
description: ''
type: string
- name: textFormat
uid: botframework-schema.Activity.textFormat
package: botframework-schema
summary: >-
Format of text fields Default:markdown. Possible values include:
'markdown', 'plain', 'xml'
fullName: textFormat
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: 'textFormat?: TextFormatTypes | string'
return:
description: ''
type: <xref uid="botframework-schema.TextFormatTypes" /> | string
- name: textHighlights
uid: botframework-schema.Activity.textHighlights
package: botframework-schema
summary: >-
The collection of text fragments to highlight when the activity contains a
ReplyToId value.
fullName: textHighlights
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: 'textHighlights?: TextHighlight[]'
return:
description: ''
type: '<xref uid="botframework-schema.TextHighlight" />[]'
- name: timestamp
uid: botframework-schema.Activity.timestamp
package: botframework-schema
summary: >-
Contains the date and time that the message was sent, in UTC, expressed in
ISO-8601 format.
fullName: timestamp
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: 'timestamp?: Date'
return:
description: ''
type: Date
- name: topicName
uid: botframework-schema.Activity.topicName
package: botframework-schema
summary: The updated topic name of the conversation.
fullName: topicName
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: 'topicName?: string'
return:
description: ''
type: string
- name: type
uid: botframework-schema.Activity.type
package: botframework-schema
summary: >-
Contains the activity type. Possible values include: 'message',
'contactRelationUpdate',
'conversationUpdate', 'typing', 'endOfConversation', 'event', 'invoke',
'deleteUserData',
'messageUpdate', 'messageDelete', 'installationUpdate', 'messageReaction',
'suggestion',
'trace', 'handoff'
fullName: type
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: 'type: ActivityTypes | string'
return:
description: ''
type: <xref uid="botframework-schema.ActivityTypes" /> | string
- name: value
uid: botframework-schema.Activity.value
package: botframework-schema
summary: A value that is associated with the activity.
fullName: value
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: 'value?: any'
return:
description: ''
type: any
- name: valueType
uid: botframework-schema.Activity.valueType
package: botframework-schema
summary: The type of the activity's value object.
fullName: valueType
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: 'valueType: string'
return:
description: ''
type: string