forked from Perth-Artifactory/taiga_sync
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathblock-kit-schema.json
2645 lines (2645 loc) · 135 KB
/
block-kit-schema.json
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
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
{
"$schema": "http://json-schema.org/draft-07/schema#",
"type": "array",
"items": {
"type": "object",
"properties": {
"type": {
"enum": [
"image",
"context",
"actions",
"divider",
"section",
"input",
"file",
"header",
"video",
"rich_text"
]
}
},
"required": [
"type"
],
"additionalProperties": true,
"allOf": [
{
"if": {
"properties": {
"type": {
"const": "image"
}
}
},
"then": {
"$ref": "#/definitions/ImageBlock"
}
},
{
"if": {
"properties": {
"type": {
"const": "context"
}
}
},
"then": {
"$ref": "#/definitions/ContextBlock"
}
},
{
"if": {
"properties": {
"type": {
"const": "actions"
}
}
},
"then": {
"$ref": "#/definitions/ActionsBlock"
}
},
{
"if": {
"properties": {
"type": {
"const": "divider"
}
}
},
"then": {
"$ref": "#/definitions/DividerBlock"
}
},
{
"if": {
"properties": {
"type": {
"const": "section"
}
}
},
"then": {
"$ref": "#/definitions/SectionBlock"
}
},
{
"if": {
"properties": {
"type": {
"const": "Input"
}
}
},
"then": {
"$ref": "#/definitions/InputBlock"
}
},
{
"if": {
"properties": {
"type": {
"const": "Video"
}
}
},
"then": {
"$ref": "#/definitions/VideoBlock"
}
},
{
"if": {
"properties": {
"type": {
"const": "rich_text"
}
}
},
"then": {
"$ref": "#/definitions/RichTextBlock"
}
}
]
},
"definitions": {
"KnownBlock": {
"oneOf": [
{
"$ref": "#/definitions/ImageBlock"
},
{
"$ref": "#/definitions/ContextBlock"
},
{
"$ref": "#/definitions/ActionsBlock"
},
{
"$ref": "#/definitions/DividerBlock"
},
{
"$ref": "#/definitions/SectionBlock"
},
{
"$ref": "#/definitions/InputBlock"
},
{
"$ref": "#/definitions/FileBlock"
},
{
"$ref": "#/definitions/HeaderBlock"
},
{
"$ref": "#/definitions/VideoBlock"
},
{
"$ref": "#/definitions/RichTextBlock"
}
]
},
"ImageBlock": {
"type": "object",
"properties": {
"type": {
"type": "string",
"const": "image",
"description": "The type of block. For an image block, `type` is always `image`."
},
"block_id": {
"type": "string",
"description": "A string acting as a unique identifier for a block. If not specified, a `block_id` will be generated.\nYou can use this `block_id` when you receive an interaction payload to\n{@link https://api.slack.com/interactivity/handling#payloads identify the source of the action}.\nMaximum length for this field is 255 characters. `block_id` should be unique for each message and each iteration of\na message. If a message is updated, use a new `block_id`."
},
"image_url": {
"type": "string",
"description": "The URL of the image to be displayed. Maximum length for this field is 3000 characters."
},
"alt_text": {
"type": "string",
"description": "A plain-text summary of the image. This should not contain any markup.\nMaximum length for this field is 2000 characters."
},
"title": {
"$ref": "#/definitions/PlainTextElement",
"description": "An optional title for the image in the form of a {@link PlainTextElement } object.\nMaximum length for the text in this field is 2000 characters."
}
},
"required": [
"alt_text",
"image_url",
"type"
],
"additionalProperties": false,
"description": "Displays an image. A simple image block, designed to make those cat photos really pop."
},
"PlainTextElement": {
"type": "object",
"properties": {
"type": {
"type": "string",
"const": "plain_text",
"description": "The formatting to use for this text object."
},
"text": {
"type": "string",
"description": "The text for the block. The minimum length is 1 and maximum length is 3000 characters."
},
"emoji": {
"type": "boolean",
"description": "Indicates whether emojis in a text field should be escaped into the colon emoji format."
}
},
"required": [
"type",
"text"
],
"additionalProperties": false,
"description": "Defines an object containing some text."
},
"ContextBlock": {
"type": "object",
"properties": {
"type": {
"type": "string",
"const": "context",
"description": "The type of block. For a context block, `type` is always `context`."
},
"block_id": {
"type": "string",
"description": "A string acting as a unique identifier for a block. If not specified, a `block_id` will be generated.\nYou can use this `block_id` when you receive an interaction payload to\n{@link https://api.slack.com/interactivity/handling#payloads identify the source of the action}.\nMaximum length for this field is 255 characters. `block_id` should be unique for each message and each iteration of\na message. If a message is updated, use a new `block_id`."
},
"elements": {
"type": "array",
"items": {
"anyOf": [
{
"$ref": "#/definitions/ImageElement"
},
{
"$ref": "#/definitions/PlainTextElement"
},
{
"$ref": "#/definitions/MrkdwnElement"
}
]
},
"description": "An array of {@link ImageElement }, {@link PlainTextElement } or {@link MrkdwnElement } objects.\nMaximum number of items is 10."
}
},
"required": [
"elements",
"type"
],
"additionalProperties": false,
"description": "Displays contextual info, which can include both images and text."
},
"ImageElement": {
"type": "object",
"properties": {
"type": {
"type": "string",
"const": "image",
"description": "The type of element. In this case `type` is always `image`."
},
"image_url": {
"type": "string",
"description": "The URL of the image to be displayed."
},
"alt_text": {
"type": "string",
"description": "A plain-text summary of the image. This should not contain any markup."
}
},
"required": [
"type",
"image_url",
"alt_text"
],
"additionalProperties": false,
"description": "Displays an image as part of a larger block of content. Use this `image` block if you want a block with\nonly an image in it."
},
"MrkdwnElement": {
"type": "object",
"properties": {
"type": {
"type": "string",
"const": "mrkdwn",
"description": "The formatting to use for this text object."
},
"text": {
"type": "string",
"description": "The text for the block. This field accepts any of the standard text formatting markup.\nThe minimum length is 1 and maximum length is 3000 characters."
},
"verbatim": {
"type": "boolean",
"description": "When set to `false` (as is default) URLs will be auto-converted into links, conversation names will\nbe link-ified, and certain mentions will be {@link https://api.slack.com/reference/surfaces/formatting#automatic-parsing automatically parsed}.\nUsing a value of `true` will skip any preprocessing of this nature, although you can still include\n{@link https://api.slack.com/reference/surfaces/formatting#advanced manual parsing strings}."
}
},
"required": [
"type",
"text"
],
"additionalProperties": false,
"description": "Defines an object containing some text."
},
"ActionsBlock": {
"type": "object",
"properties": {
"type": {
"type": "string",
"const": "actions",
"description": "The type of block. For an actions block, `type` is always `actions`."
},
"block_id": {
"type": "string",
"description": "A string acting as a unique identifier for a block. If not specified, a `block_id` will be generated.\nYou can use this `block_id` when you receive an interaction payload to\n{@link https://api.slack.com/interactivity/handling#payloads identify the source of the action}.\nMaximum length for this field is 255 characters. `block_id` should be unique for each message and each iteration of\na message. If a message is updated, use a new `block_id`."
},
"elements": {
"type": "array",
"items": {
"anyOf": [
{
"$ref": "#/definitions/Button"
},
{
"$ref": "#/definitions/Checkboxes"
},
{
"$ref": "#/definitions/Datepicker"
},
{
"$ref": "#/definitions/DateTimepicker"
},
{
"$ref": "#/definitions/MultiSelect"
},
{
"$ref": "#/definitions/Overflow"
},
{
"$ref": "#/definitions/RadioButtons"
},
{
"$ref": "#/definitions/Select"
},
{
"$ref": "#/definitions/Timepicker"
},
{
"$ref": "#/definitions/WorkflowButton"
},
{
"$ref": "#/definitions/RichTextInput"
}
]
},
"description": "An array of {@link InteractiveElements } objects.\nThere is a maximum of 25 elements in each action block."
}
},
"required": [
"elements",
"type"
],
"additionalProperties": false,
"description": "Holds multiple interactive elements."
},
"Button": {
"type": "object",
"properties": {
"confirm": {
"$ref": "#/definitions/ConfirmationDialog",
"description": "A {@link Confirm } object that defines an optional confirmation dialog after the element is interacted\nwith."
},
"type": {
"type": "string",
"const": "button",
"description": "The type of element. In this case `type` is always `button`."
},
"action_id": {
"type": "string",
"description": ": An identifier for this action. You can use this when you receive an interaction payload to\n{@link https://api.slack.com/interactivity/handling#payloads identify the source of the action}. Should be unique\namong all other `action_id`s in the containing block. Maximum length for this field is 255 characters."
},
"text": {
"$ref": "#/definitions/PlainTextElement",
"description": "A {@link PlainTextElement } that defines the button's text. `text` may truncate with ~30 characters.\nMaximum length for the text in this field is 75 characters."
},
"value": {
"type": "string",
"description": "The value to send along with the {@link https://api.slack.com/interactivity/handling#payloads interaction payload}.\nMaximum length for this field is 2000 characters."
},
"url": {
"type": "string",
"description": "A URL to load in the user's browser when the button is clicked. Maximum length for this field is 3000\ncharacters. If you're using `url`, you'll still receive an {@link https://api.slack.com/interactivity/handling#payloads interaction payload}\nand will need to send an {@link https://api.slack.com/interactivity/handling#acknowledgment_response acknowledgement response}."
},
"style": {
"type": "string",
"enum": [
"danger",
"primary"
],
"description": "Decorates buttons with alternative visual color schemes. Use this option with restraint.\n`primary` gives buttons a green outline and text, ideal for affirmation or confirmation actions. `primary` should\nonly be used for one button within a set.\n`danger` gives buttons a red outline and text, and should be used when the action is destructive. Use `danger` even\nmore sparingly than primary.\nIf you don't include this field, the default button style will be used."
},
"accessibility_label": {
"type": "string",
"description": "A label for longer descriptive text about a button element. This label will be read out by screen\nreaders instead of the button `text` object. Maximum length for this field is 75 characters."
}
},
"required": [
"text",
"type"
],
"additionalProperties": false,
"description": "Allows users a direct path to performing basic actions."
},
"Actionable": {
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"type": "string"
},
"action_id": {
"type": "string",
"description": ": An identifier for this action. You can use this when you receive an interaction payload to\n{@link https://api.slack.com/interactivity/handling#payloads identify the source of the action}. Should be unique\namong all other `action_id`s in the containing block. Maximum length for this field is 255 characters."
}
},
"required": [
"type"
]
},
"Action": {
"type": "object",
"properties": {
"type": {
"type": "string"
},
"action_id": {
"type": "string",
"description": ": An identifier for this action. You can use this when you receive an interaction payload to\n{@link https://api.slack.com/interactivity/handling#payloads identify the source of the action}. Should be unique\namong all other `action_id`s in the containing block. Maximum length for this field is 255 characters."
}
},
"required": [
"type"
],
"additionalProperties": false,
"deprecated": "{@link Action } aliased to {@link Actionable } in order to name the mixins in this file consistently."
},
"Confirmable": {
"type": "object",
"properties": {
"confirm": {
"$ref": "#/definitions/ConfirmationDialog",
"description": "A {@link Confirm } object that defines an optional confirmation dialog after the element is interacted\nwith."
}
},
"additionalProperties": false
},
"ConfirmationDialog": {
"type": "object",
"additionalProperties": false,
"properties": {
"title": {
"$ref": "#/definitions/PlainTextElement",
"description": "A {@link PlainTextElement } text object that defines the dialog's title.\nMaximum length for this field is 100 characters."
},
"text": {
"anyOf": [
{
"$ref": "#/definitions/PlainTextElement"
},
{
"$ref": "#/definitions/MrkdwnElement"
}
],
"description": "A {@link PlainTextElement } text object that defines the explanatory text that appears in the confirm\ndialog. Maximum length for the `text` in this field is 300 characters."
},
"confirm": {
"$ref": "#/definitions/PlainTextElement",
"description": "A {@link PlainTextElement } text object to define the text of the button that confirms the action.\nMaximum length for the `text` in this field is 30 characters."
},
"deny": {
"$ref": "#/definitions/PlainTextElement",
"description": "A {@link PlainTextElement } text object to define the text of the button that cancels the action.\nMaximum length for the `text` in this field is 30 characters."
},
"style": {
"type": "string",
"enum": [
"primary",
"danger"
],
"description": "Defines the color scheme applied to the `confirm` button. A value of `danger` will display the button\nwith a red background on desktop, or red text on mobile. A value of `primary` will display the button with a green\nbackground on desktop, or blue text on mobile. If this field is not provided, the default value will be `primary`."
}
},
"required": [
"text"
],
"description": "Defines a dialog that adds a confirmation step to interactive elements."
},
"Confirm": {
"type": "object",
"properties": {
"title": {
"$ref": "#/definitions/PlainTextElement",
"description": "A {@link PlainTextElement } text object that defines the dialog's title.\nMaximum length for this field is 100 characters."
},
"text": {
"anyOf": [
{
"$ref": "#/definitions/PlainTextElement"
},
{
"$ref": "#/definitions/MrkdwnElement"
}
],
"description": "A {@link PlainTextElement } text object that defines the explanatory text that appears in the confirm\ndialog. Maximum length for the `text` in this field is 300 characters."
},
"confirm": {
"$ref": "#/definitions/PlainTextElement",
"description": "A {@link PlainTextElement } text object to define the text of the button that confirms the action.\nMaximum length for the `text` in this field is 30 characters."
},
"deny": {
"$ref": "#/definitions/PlainTextElement",
"description": "A {@link PlainTextElement } text object to define the text of the button that cancels the action.\nMaximum length for the `text` in this field is 30 characters."
},
"style": {
"type": "string",
"enum": [
"primary",
"danger"
],
"description": "Defines the color scheme applied to the `confirm` button. A value of `danger` will display the button\nwith a red background on desktop, or red text on mobile. A value of `primary` will display the button with a green\nbackground on desktop, or blue text on mobile. If this field is not provided, the default value will be `primary`."
}
},
"required": [
"text"
],
"additionalProperties": false,
"deprecated": "{@link Confirm } aliased to {@link ConfirmationDialog } in order to make the construct clearer\nand line up terminology with api.slack.com.",
"description": "Defines a dialog that adds a confirmation step to interactive elements."
},
"Checkboxes": {
"type": "object",
"properties": {
"focus_on_load": {
"type": "boolean",
"description": "Indicates whether the element will be set to auto focus within the\n{@link https://api.slack.com/reference/surfaces/views `view` object}. Only one element can be set to `true`.\nDefaults to `false`."
},
"confirm": {
"$ref": "#/definitions/ConfirmationDialog",
"description": "A {@link Confirm } object that defines an optional confirmation dialog after the element is interacted\nwith."
},
"type": {
"type": "string",
"const": "checkboxes",
"description": "The type of element. In this case `type` is always `checkboxes`."
},
"action_id": {
"type": "string",
"description": ": An identifier for this action. You can use this when you receive an interaction payload to\n{@link https://api.slack.com/interactivity/handling#payloads identify the source of the action}. Should be unique\namong all other `action_id`s in the containing block. Maximum length for this field is 255 characters."
},
"initial_options": {
"type": "array",
"items": {
"$ref": "#/definitions/Option"
},
"description": "An array of {@link Option } objects that exactly matches one or more of the options within `options`.\nThese options will be selected when the checkbox group initially loads."
},
"options": {
"type": "array",
"items": {
"$ref": "#/definitions/Option"
},
"description": "An array of {@link Option } objects. A maximum of 10 options are allowed."
}
},
"required": [
"options",
"type"
],
"additionalProperties": false,
"description": "Allows users to choose multiple items from a list of options."
},
"Focusable": {
"type": "object",
"properties": {
"focus_on_load": {
"type": "boolean",
"description": "Indicates whether the element will be set to auto focus within the\n{@link https://api.slack.com/reference/surfaces/views `view` object}. Only one element can be set to `true`.\nDefaults to `false`."
}
},
"additionalProperties": false
},
"Option": {
"anyOf": [
{
"$ref": "#/definitions/MrkdwnOption"
},
{
"$ref": "#/definitions/PlainTextOption"
}
],
"description": "Defines a single item in a number of item selection elements. An object that represents a single\nselectable item in a select menu, multi-select menu, checkbox group, radio button group, or overflow menu."
},
"MrkdwnOption": {
"type": "object",
"properties": {
"value": {
"type": "string",
"description": "A unique string value that will be passed to your app when this option is chosen.\nMaximum length for this field is 75 characters."
},
"url": {
"type": "string",
"description": "Only available in overflow menus! A URL to load in the user's browser when the option is clicked.\nMaximum length for this field is 3000 characters."
},
"description": {
"$ref": "#/definitions/PlainTextElement",
"description": "A {@link PlainTextElement } that defines a line of descriptive text shown below the `text` field.\nMaximum length for the `text` within this field is 75 characters."
},
"text": {
"$ref": "#/definitions/MrkdwnElement",
"description": "A {@link MrkdwnElement } that defines the text shown in the option on the menu. To be used with\nradio buttons and checkboxes. Maximum length for the `text` in this field is 75 characters."
}
},
"required": [
"text"
],
"additionalProperties": false
},
"PlainTextOption": {
"type": "object",
"properties": {
"value": {
"type": "string",
"description": "A unique string value that will be passed to your app when this option is chosen.\nMaximum length for this field is 75 characters."
},
"url": {
"type": "string",
"description": "Only available in overflow menus! A URL to load in the user's browser when the option is clicked.\nMaximum length for this field is 3000 characters."
},
"description": {
"$ref": "#/definitions/PlainTextElement",
"description": "A {@link PlainTextElement } that defines a line of descriptive text shown below the `text` field.\nMaximum length for the `text` within this field is 75 characters."
},
"text": {
"$ref": "#/definitions/PlainTextElement",
"description": "A {@link PlainTextElement } that defines the text shown in the option on the menu. To be used with\noverflow, select and multi-select menus. Maximum length for the `text` in this field is 75 characters."
}
},
"required": [
"text"
],
"additionalProperties": false
},
"Datepicker": {
"type": "object",
"properties": {
"placeholder": {
"$ref": "#/definitions/PlainTextElement",
"description": "A {@link PlainTextElement } object that defines the placeholder text shown on the element. Maximum\nlength for the `text` field in this object is 150 characters."
},
"focus_on_load": {
"type": "boolean",
"description": "Indicates whether the element will be set to auto focus within the\n{@link https://api.slack.com/reference/surfaces/views `view` object}. Only one element can be set to `true`.\nDefaults to `false`."
},
"confirm": {
"$ref": "#/definitions/ConfirmationDialog",
"description": "A {@link Confirm } object that defines an optional confirmation dialog after the element is interacted\nwith."
},
"type": {
"type": "string",
"const": "datepicker",
"description": "The type of element. In this case `type` is always `datepicker`."
},
"action_id": {
"type": "string",
"description": ": An identifier for this action. You can use this when you receive an interaction payload to\n{@link https://api.slack.com/interactivity/handling#payloads identify the source of the action}. Should be unique\namong all other `action_id`s in the containing block. Maximum length for this field is 255 characters."
},
"initial_date": {
"type": "string",
"description": "The initial date that is selected when the element is loaded.\nThis should be in the format `YYYY-MM-DD`."
}
},
"required": [
"type"
],
"additionalProperties": false,
"description": "Allows users to select a date from a calendar style UI."
},
"Placeholdable": {
"type": "object",
"properties": {
"placeholder": {
"$ref": "#/definitions/PlainTextElement",
"description": "A {@link PlainTextElement } object that defines the placeholder text shown on the element. Maximum\nlength for the `text` field in this object is 150 characters."
}
},
"additionalProperties": false
},
"DateTimepicker": {
"type": "object",
"properties": {
"focus_on_load": {
"type": "boolean",
"description": "Indicates whether the element will be set to auto focus within the\n{@link https://api.slack.com/reference/surfaces/views `view` object}. Only one element can be set to `true`.\nDefaults to `false`."
},
"confirm": {
"$ref": "#/definitions/ConfirmationDialog",
"description": "A {@link Confirm } object that defines an optional confirmation dialog after the element is interacted\nwith."
},
"type": {
"type": "string",
"const": "datetimepicker",
"description": "The type of element. In this case `type` is always `datetimepicker`."
},
"action_id": {
"type": "string",
"description": ": An identifier for this action. You can use this when you receive an interaction payload to\n{@link https://api.slack.com/interactivity/handling#payloads identify the source of the action}. Should be unique\namong all other `action_id`s in the containing block. Maximum length for this field is 255 characters."
},
"initial_date_time": {
"type": "number",
"description": "The initial date and time that is selected when the element is loaded, represented as a UNIX\ntimestamp in seconds. This should be in the format of 10 digits, for example `1628633820` represents the date and\ntime August 10th, 2021 at 03:17pm PST."
}
},
"required": [
"type"
],
"additionalProperties": false,
"description": "Allows users to select both a date and a time of day, formatted as a Unix timestamp. On desktop\nclients, this time picker will take the form of a dropdown list and the date picker will take the form of a dropdown\ncalendar. Both options will have free-text entry for precise choices. On mobile clients, the time picker and date\npicker will use native UIs."
},
"MultiSelect": {
"anyOf": [
{
"$ref": "#/definitions/MultiUsersSelect"
},
{
"$ref": "#/definitions/MultiStaticSelect"
},
{
"$ref": "#/definitions/MultiConversationsSelect"
},
{
"$ref": "#/definitions/MultiChannelsSelect"
},
{
"$ref": "#/definitions/MultiExternalSelect"
}
],
"description": "Allows users to select multiple items from a list of options.\nJust like regular {@link Select }, multi-select menus also include type-ahead functionality, where a user can type a\npart or all of an option string to filter the list.\nThere are different types of multi-select menu that depend on different data sources for their lists of options:\n{@link MultiStaticSelect }, {@link MultiExternalSelect }, {@link MultiUsersSelect }, {@link MultiConversationsSelect },\n{@link MultiChannelsSelect }."
},
"MultiUsersSelect": {
"type": "object",
"properties": {
"placeholder": {
"$ref": "#/definitions/PlainTextElement",
"description": "A {@link PlainTextElement } object that defines the placeholder text shown on the element. Maximum\nlength for the `text` field in this object is 150 characters."
},
"focus_on_load": {
"type": "boolean",
"description": "Indicates whether the element will be set to auto focus within the\n{@link https://api.slack.com/reference/surfaces/views `view` object}. Only one element can be set to `true`.\nDefaults to `false`."
},
"confirm": {
"$ref": "#/definitions/ConfirmationDialog",
"description": "A {@link Confirm } object that defines an optional confirmation dialog after the element is interacted\nwith."
},
"type": {
"type": "string",
"const": "multi_users_select",
"description": "The type of element. In this case `type` is always `multi_users_select`."
},
"action_id": {
"type": "string",
"description": ": An identifier for this action. You can use this when you receive an interaction payload to\n{@link https://api.slack.com/interactivity/handling#payloads identify the source of the action}. Should be unique\namong all other `action_id`s in the containing block. Maximum length for this field is 255 characters."
},
"initial_users": {
"type": "array",
"items": {
"type": "string"
},
"description": "An array of user IDs of any valid users to be pre-selected when the menu loads."
},
"max_selected_items": {
"type": "number",
"description": "Specifies the maximum number of items that can be selected in the menu. Minimum number is `1`."
}
},
"required": [
"type"
],
"additionalProperties": false,
"description": "This multi-select menu will populate its options with a list of Slack users visible to the current user\nin the active workspace."
},
"MultiStaticSelect": {
"type": "object",
"properties": {
"placeholder": {
"$ref": "#/definitions/PlainTextElement",
"description": "A {@link PlainTextElement } object that defines the placeholder text shown on the element. Maximum\nlength for the `text` field in this object is 150 characters."
},
"focus_on_load": {
"type": "boolean",
"description": "Indicates whether the element will be set to auto focus within the\n{@link https://api.slack.com/reference/surfaces/views `view` object}. Only one element can be set to `true`.\nDefaults to `false`."
},
"confirm": {
"$ref": "#/definitions/ConfirmationDialog",
"description": "A {@link Confirm } object that defines an optional confirmation dialog after the element is interacted\nwith."
},
"type": {
"type": "string",
"const": "multi_static_select",
"description": "The type of element. In this case `type` is always `multi_static_select`."
},
"action_id": {
"type": "string",
"description": ": An identifier for this action. You can use this when you receive an interaction payload to\n{@link https://api.slack.com/interactivity/handling#payloads identify the source of the action}. Should be unique\namong all other `action_id`s in the containing block. Maximum length for this field is 255 characters."
},
"initial_options": {
"type": "array",
"items": {
"$ref": "#/definitions/PlainTextOption"
},
"description": "An array of option objects that exactly match one or more of the options within `options` or\n`option_groups`. These options will be selected when the menu initially loads."
},
"options": {
"type": "array",
"items": {
"$ref": "#/definitions/PlainTextOption"
},
"description": "An array of {@link PlainTextOption }. Maximum number of options is 100. If `option_groups` is\nspecified, this field should not be."
},
"option_groups": {
"type": "array",
"items": {
"type": "object",
"properties": {
"label": {
"$ref": "#/definitions/PlainTextElement"
},
"options": {
"type": "array",
"items": {
"$ref": "#/definitions/PlainTextOption"
}
}
},
"required": [
"label",
"options"
],
"additionalProperties": false
},
"description": "An array of option group objects. Maximum number of option groups is 100. If `options` is specified,\nthis field should not be."
},
"max_selected_items": {
"type": "number",
"description": "Specifies the maximum number of items that can be selected in the menu. Minimum number is 1."
}
},
"required": [
"type"
],
"additionalProperties": false,
"description": "This is the simplest form of select menu, with a static list of options passed in when defining the\nelement."
},
"MultiConversationsSelect": {
"type": "object",
"properties": {
"placeholder": {
"$ref": "#/definitions/PlainTextElement",
"description": "A {@link PlainTextElement } object that defines the placeholder text shown on the element. Maximum\nlength for the `text` field in this object is 150 characters."
},
"focus_on_load": {
"type": "boolean",
"description": "Indicates whether the element will be set to auto focus within the\n{@link https://api.slack.com/reference/surfaces/views `view` object}. Only one element can be set to `true`.\nDefaults to `false`."
},
"confirm": {
"$ref": "#/definitions/ConfirmationDialog",
"description": "A {@link Confirm } object that defines an optional confirmation dialog after the element is interacted\nwith."
},
"type": {
"type": "string",
"const": "multi_conversations_select",
"description": "The type of element. In this case `type` is always `conversations_select`."
},
"action_id": {
"type": "string",
"description": ": An identifier for this action. You can use this when you receive an interaction payload to\n{@link https://api.slack.com/interactivity/handling#payloads identify the source of the action}. Should be unique\namong all other `action_id`s in the containing block. Maximum length for this field is 255 characters."
},
"initial_conversations": {
"type": "array",
"items": {
"type": "string"
},
"description": "An array of one or more IDs of any valid conversations to be pre-selected when the menu loads. If\n`default_to_current_conversation` is also supplied, `initial_conversation` will be ignored."
},
"max_selected_items": {
"type": "number",
"description": "Specifies the maximum number of items that can be selected in the menu. Minimum number is 1."
},
"default_to_current_conversation": {
"type": "boolean",
"description": "Pre-populates the select menu with the conversation that the user was viewing when they opened the\nmodal, if available. Default is `false`."
},
"filter": {
"type": "object",
"properties": {
"include": {
"type": "array",
"items": {
"type": "string",
"enum": [
"im",
"mpim",
"private",
"public"
]
}
},
"exclude_external_shared_channels": {
"type": "boolean"
},
"exclude_bot_users": {
"type": "boolean"
}
},
"additionalProperties": false,
"description": "A filter object that reduces the list of available conversations using the specified criteria."
}
},
"required": [
"type"
],
"additionalProperties": false,
"description": "This multi-select menu will populate its options with a list of public and private channels, DMs, and\nMPIMs visible to the current user in the active workspace."
},
"MultiChannelsSelect": {
"type": "object",
"properties": {
"placeholder": {
"$ref": "#/definitions/PlainTextElement",
"description": "A {@link PlainTextElement } object that defines the placeholder text shown on the element. Maximum\nlength for the `text` field in this object is 150 characters."
},
"focus_on_load": {
"type": "boolean",
"description": "Indicates whether the element will be set to auto focus within the\n{@link https://api.slack.com/reference/surfaces/views `view` object}. Only one element can be set to `true`.\nDefaults to `false`."
},
"confirm": {
"$ref": "#/definitions/ConfirmationDialog",
"description": "A {@link Confirm } object that defines an optional confirmation dialog after the element is interacted\nwith."
},
"type": {
"type": "string",
"const": "multi_channels_select",
"description": "The type of element. In this case `type` is always `multi_channels_select`."
},
"action_id": {
"type": "string",
"description": ": An identifier for this action. You can use this when you receive an interaction payload to\n{@link https://api.slack.com/interactivity/handling#payloads identify the source of the action}. Should be unique\namong all other `action_id`s in the containing block. Maximum length for this field is 255 characters."
},
"initial_channels": {
"type": "array",
"items": {
"type": "string"
},
"description": "An array of one or more IDs of any valid public channel to be pre-selected when the menu loads."
},
"max_selected_items": {
"type": "number",
"description": "Specifies the maximum number of items that can be selected in the menu. Minimum number is 1."
}
},
"required": [
"type"
],
"additionalProperties": false,
"description": "This multi-select menu will populate its options with a list of public channels visible to the current\nuser in the active workspace."
},
"MultiExternalSelect": {
"type": "object",
"properties": {
"placeholder": {
"$ref": "#/definitions/PlainTextElement",
"description": "A {@link PlainTextElement } object that defines the placeholder text shown on the element. Maximum\nlength for the `text` field in this object is 150 characters."
},
"focus_on_load": {
"type": "boolean",
"description": "Indicates whether the element will be set to auto focus within the\n{@link https://api.slack.com/reference/surfaces/views `view` object}. Only one element can be set to `true`.\nDefaults to `false`."
},
"confirm": {
"$ref": "#/definitions/ConfirmationDialog",
"description": "A {@link Confirm } object that defines an optional confirmation dialog after the element is interacted\nwith."
},
"type": {
"type": "string",
"const": "multi_external_select",
"description": "The type of element. In this case `type` is always `multi_external_select`."
},
"action_id": {
"type": "string",
"description": ": An identifier for this action. You can use this when you receive an interaction payload to\n{@link https://api.slack.com/interactivity/handling#payloads identify the source of the action}. Should be unique\namong all other `action_id`s in the containing block. Maximum length for this field is 255 characters."
},
"initial_options": {
"type": "array",
"items": {