Deployed 506b5bb to 5.4 with MkDocs 1.1.2 and mike 0.5.5
[GitHub/WoltLab/woltlab.github.io.git] / latest / package / pip / user-notification-event / index.html
1
2 <!doctype html>
3 <html lang="en" class="no-js">
4 <head>
5
6 <meta charset="utf-8">
7 <meta name="viewport" content="width=device-width,initial-scale=1">
8
9
10
11
12 <link rel="shortcut icon" href="../../../assets/default.favicon.ico">
13 <meta name="generator" content="mkdocs-1.1.2, mkdocs-material-7.0.5">
14
15
16
17 <title>userNotificationEvent - WoltLab Suite Documentation</title>
18
19
20
21 <link rel="stylesheet" href="../../../assets/stylesheets/main.77f3fd56.min.css">
22
23
24 <link rel="stylesheet" href="../../../assets/stylesheets/palette.7fa14f5b.min.css">
25
26
27
28 <meta name="theme-color" content="#009485">
29
30
31
32
33
34
35
36
37 <link rel="stylesheet" href="../../../stylesheets/extra.css">
38
39
40
41
42
43 </head>
44
45
46
47
48
49
50
51 <body dir="ltr" data-md-color-scheme="" data-md-color-primary="teal" data-md-color-accent="">
52
53
54
55 <input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
56 <input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
57 <label class="md-overlay" for="__drawer"></label>
58 <div data-md-component="skip">
59
60
61 <a href="#user-notification-event-package-installation-plugin" class="md-skip">
62 Skip to content
63 </a>
64
65 </div>
66 <div data-md-component="announce">
67
68 <aside class="md-announce">
69 <div class="md-announce__inner md-grid md-typeset">
70
71 <a href="https://www.woltlab.com">Back to <strong>woltlab.com</strong></a>
72
73 </div>
74 </aside>
75
76 </div>
77
78
79
80 <header class="md-header" data-md-component="header">
81 <nav class="md-header__inner md-grid" aria-label="Header">
82 <a href="../../.." title="WoltLab Suite Documentation" class="md-header__button md-logo" aria-label="WoltLab Suite Documentation">
83
84 <img src="../../../assets/logo.png" alt="logo">
85
86 </a>
87 <label class="md-header__button md-icon" for="__drawer">
88 <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3 6h18v2H3V6m0 5h18v2H3v-2m0 5h18v2H3v-2z"/></svg>
89 </label>
90 <div class="md-header__title" data-md-component="header-title">
91 <div class="md-header__ellipsis">
92 <div class="md-header__topic">
93 <span class="md-ellipsis">
94 WoltLab Suite Documentation
95 </span>
96 </div>
97 <div class="md-header__topic" data-md-component="header-topic">
98 <span class="md-ellipsis">
99
100 userNotificationEvent
101
102 </span>
103 </div>
104 </div>
105 </div>
106 <div class="md-header__options">
107
108 </div>
109
110 <label class="md-header__button md-icon" for="__search">
111 <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.516 6.516 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5z"/></svg>
112 </label>
113
114 <div class="md-search" data-md-component="search" role="dialog">
115 <label class="md-search__overlay" for="__search"></label>
116 <div class="md-search__inner" role="search">
117 <form class="md-search__form" name="search">
118 <input type="text" class="md-search__input" name="query" aria-label="Search" placeholder="Search" autocapitalize="off" autocorrect="off" autocomplete="off" spellcheck="false" data-md-component="search-query" data-md-state="active" required>
119 <label class="md-search__icon md-icon" for="__search">
120 <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.516 6.516 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5z"/></svg>
121 <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11h12z"/></svg>
122 </label>
123 <button type="reset" class="md-search__icon md-icon" aria-label="Clear" tabindex="-1">
124 <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M19 6.41L17.59 5 12 10.59 6.41 5 5 6.41 10.59 12 5 17.59 6.41 19 12 13.41 17.59 19 19 17.59 13.41 12 19 6.41z"/></svg>
125 </button>
126 </form>
127 <div class="md-search__output">
128 <div class="md-search__scrollwrap" data-md-scrollfix>
129 <div class="md-search-result" data-md-component="search-result">
130 <div class="md-search-result__meta">
131 Initializing search
132 </div>
133 <ol class="md-search-result__list"></ol>
134 </div>
135 </div>
136 </div>
137 </div>
138 </div>
139
140
141 </nav>
142 </header>
143
144 <div class="md-container" data-md-component="container">
145
146
147
148
149 <main class="md-main" data-md-component="main">
150 <div class="md-main__inner md-grid">
151
152
153
154 <div class="md-sidebar md-sidebar--primary" data-md-component="sidebar" data-md-type="navigation" >
155 <div class="md-sidebar__scrollwrap">
156 <div class="md-sidebar__inner">
157
158
159
160
161
162 <nav class="md-nav md-nav--primary" aria-label="Navigation" data-md-level="0">
163 <label class="md-nav__title" for="__drawer">
164 <a href="../../.." title="WoltLab Suite Documentation" class="md-nav__button md-logo" aria-label="WoltLab Suite Documentation">
165
166 <img src="../../../assets/logo.png" alt="logo">
167
168 </a>
169 WoltLab Suite Documentation
170 </label>
171
172 <ul class="md-nav__list" data-md-scrollfix>
173
174
175
176
177
178
179
180
181 <li class="md-nav__item">
182 <a href="../../../getting-started/" class="md-nav__link">
183 Getting Started
184 </a>
185 </li>
186
187
188
189
190
191
192
193
194
195
196
197 <li class="md-nav__item md-nav__item--nested">
198
199
200 <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_2" type="checkbox" id="__nav_2" >
201
202 <label class="md-nav__link" for="__nav_2">
203 PHP API
204 <span class="md-nav__icon md-icon"></span>
205 </label>
206 <nav class="md-nav" aria-label="PHP API" data-md-level="1">
207 <label class="md-nav__title" for="__nav_2">
208 <span class="md-nav__icon md-icon"></span>
209 PHP API
210 </label>
211 <ul class="md-nav__list" data-md-scrollfix>
212
213
214
215
216
217 <li class="md-nav__item">
218 <a href="../../../php/pages/" class="md-nav__link">
219 Pages
220 </a>
221 </li>
222
223
224
225
226
227
228
229 <li class="md-nav__item">
230 <a href="../../../php/database-objects/" class="md-nav__link">
231 Database Objects
232 </a>
233 </li>
234
235
236
237
238
239
240
241 <li class="md-nav__item">
242 <a href="../../../php/database-access/" class="md-nav__link">
243 Database Access
244 </a>
245 </li>
246
247
248
249
250
251
252
253 <li class="md-nav__item">
254 <a href="../../../php/exceptions/" class="md-nav__link">
255 Exceptions
256 </a>
257 </li>
258
259
260
261
262
263
264
265
266 <li class="md-nav__item md-nav__item--nested">
267
268
269 <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_2_5" type="checkbox" id="__nav_2_5" >
270
271 <label class="md-nav__link" for="__nav_2_5">
272 API
273 <span class="md-nav__icon md-icon"></span>
274 </label>
275 <nav class="md-nav" aria-label="API" data-md-level="2">
276 <label class="md-nav__title" for="__nav_2_5">
277 <span class="md-nav__icon md-icon"></span>
278 API
279 </label>
280 <ul class="md-nav__list" data-md-scrollfix>
281
282
283
284
285
286 <li class="md-nav__item">
287 <a href="../../../php/api/caches/" class="md-nav__link">
288 Caches
289 </a>
290 </li>
291
292
293
294
295
296
297
298 <li class="md-nav__item">
299 <a href="../../../php/api/comments/" class="md-nav__link">
300 Comments
301 </a>
302 </li>
303
304
305
306
307
308
309
310 <li class="md-nav__item">
311 <a href="../../../php/api/cronjobs/" class="md-nav__link">
312 Cronjobs
313 </a>
314 </li>
315
316
317
318
319
320
321
322 <li class="md-nav__item">
323 <a href="../../../php/api/events/" class="md-nav__link">
324 Events
325 </a>
326 </li>
327
328
329
330
331
332
333
334
335 <li class="md-nav__item md-nav__item--nested">
336
337
338 <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_2_5_5" type="checkbox" id="__nav_2_5_5" >
339
340 <label class="md-nav__link" for="__nav_2_5_5">
341 Form Builder
342 <span class="md-nav__icon md-icon"></span>
343 </label>
344 <nav class="md-nav" aria-label="Form Builder" data-md-level="3">
345 <label class="md-nav__title" for="__nav_2_5_5">
346 <span class="md-nav__icon md-icon"></span>
347 Form Builder
348 </label>
349 <ul class="md-nav__list" data-md-scrollfix>
350
351
352
353
354
355 <li class="md-nav__item">
356 <a href="../../../php/api/form_builder/overview/" class="md-nav__link">
357 Overview
358 </a>
359 </li>
360
361
362
363
364
365
366
367 <li class="md-nav__item">
368 <a href="../../../php/api/form_builder/structure/" class="md-nav__link">
369 Structure
370 </a>
371 </li>
372
373
374
375
376
377
378
379 <li class="md-nav__item">
380 <a href="../../../php/api/form_builder/form_fields/" class="md-nav__link">
381 Fields
382 </a>
383 </li>
384
385
386
387
388
389
390
391 <li class="md-nav__item">
392 <a href="../../../php/api/form_builder/validation_data/" class="md-nav__link">
393 Validation and Data
394 </a>
395 </li>
396
397
398
399
400
401
402
403 <li class="md-nav__item">
404 <a href="../../../php/api/form_builder/dependencies/" class="md-nav__link">
405 Dependencies
406 </a>
407 </li>
408
409
410
411 </ul>
412 </nav>
413 </li>
414
415
416
417
418
419
420
421 <li class="md-nav__item">
422 <a href="../../../php/api/package_installation_plugins/" class="md-nav__link">
423 Package Installation Plugins
424 </a>
425 </li>
426
427
428
429
430
431
432
433 <li class="md-nav__item">
434 <a href="../../../php/api/user_activity_points/" class="md-nav__link">
435 User Activity Points
436 </a>
437 </li>
438
439
440
441
442
443
444
445 <li class="md-nav__item">
446 <a href="../../../php/api/user_notifications/" class="md-nav__link">
447 User Notifications
448 </a>
449 </li>
450
451
452
453
454
455
456
457 <li class="md-nav__item">
458 <a href="../../../php/api/sitemaps/" class="md-nav__link">
459 Sitemaps
460 </a>
461 </li>
462
463
464
465 </ul>
466 </nav>
467 </li>
468
469
470
471
472
473
474
475 <li class="md-nav__item">
476 <a href="../../../php/code-style/" class="md-nav__link">
477 Code Style
478 </a>
479 </li>
480
481
482
483
484
485
486
487 <li class="md-nav__item">
488 <a href="../../../php/apps/" class="md-nav__link">
489 Apps
490 </a>
491 </li>
492
493
494
495
496
497
498
499 <li class="md-nav__item">
500 <a href="../../../php/gdpr/" class="md-nav__link">
501 GDPR
502 </a>
503 </li>
504
505
506
507 </ul>
508 </nav>
509 </li>
510
511
512
513
514
515
516
517
518
519
520
521 <li class="md-nav__item md-nav__item--nested">
522
523
524 <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_3" type="checkbox" id="__nav_3" >
525
526 <label class="md-nav__link" for="__nav_3">
527 Languages, Templates & CSS
528 <span class="md-nav__icon md-icon"></span>
529 </label>
530 <nav class="md-nav" aria-label="Languages, Templates & CSS" data-md-level="1">
531 <label class="md-nav__title" for="__nav_3">
532 <span class="md-nav__icon md-icon"></span>
533 Languages, Templates & CSS
534 </label>
535 <ul class="md-nav__list" data-md-scrollfix>
536
537
538
539
540
541 <li class="md-nav__item">
542 <a href="../../../view/languages/" class="md-nav__link">
543 Languages
544 </a>
545 </li>
546
547
548
549
550
551
552
553 <li class="md-nav__item">
554 <a href="../../../view/templates/" class="md-nav__link">
555 Templates
556 </a>
557 </li>
558
559
560
561
562
563
564
565 <li class="md-nav__item">
566 <a href="../../../view/css/" class="md-nav__link">
567 CSS
568 </a>
569 </li>
570
571
572
573 </ul>
574 </nav>
575 </li>
576
577
578
579
580
581
582
583
584
585
586
587 <li class="md-nav__item md-nav__item--nested">
588
589
590 <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_4" type="checkbox" id="__nav_4" >
591
592 <label class="md-nav__link" for="__nav_4">
593 JavaScript API
594 <span class="md-nav__icon md-icon"></span>
595 </label>
596 <nav class="md-nav" aria-label="JavaScript API" data-md-level="1">
597 <label class="md-nav__title" for="__nav_4">
598 <span class="md-nav__icon md-icon"></span>
599 JavaScript API
600 </label>
601 <ul class="md-nav__list" data-md-scrollfix>
602
603
604
605
606
607 <li class="md-nav__item">
608 <a href="../../../javascript/general-usage/" class="md-nav__link">
609 General Usage
610 </a>
611 </li>
612
613
614
615
616
617
618
619
620 <li class="md-nav__item md-nav__item--nested">
621
622
623 <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_4_2" type="checkbox" id="__nav_4_2" >
624
625 <label class="md-nav__link" for="__nav_4_2">
626 New API
627 <span class="md-nav__icon md-icon"></span>
628 </label>
629 <nav class="md-nav" aria-label="New API" data-md-level="2">
630 <label class="md-nav__title" for="__nav_4_2">
631 <span class="md-nav__icon md-icon"></span>
632 New API
633 </label>
634 <ul class="md-nav__list" data-md-scrollfix>
635
636
637
638
639
640 <li class="md-nav__item">
641 <a href="../../../javascript/new-api_writing-a-module/" class="md-nav__link">
642 Writing a module
643 </a>
644 </li>
645
646
647
648
649
650
651
652 <li class="md-nav__item">
653 <a href="../../../javascript/new-api_data-structures/" class="md-nav__link">
654 Data Structures
655 </a>
656 </li>
657
658
659
660
661
662
663
664 <li class="md-nav__item">
665 <a href="../../../javascript/new-api_core/" class="md-nav__link">
666 Core Functions
667 </a>
668 </li>
669
670
671
672
673
674
675
676 <li class="md-nav__item">
677 <a href="../../../javascript/new-api_dom/" class="md-nav__link">
678 DOM
679 </a>
680 </li>
681
682
683
684
685
686
687
688 <li class="md-nav__item">
689 <a href="../../../javascript/new-api_events/" class="md-nav__link">
690 Event Handling
691 </a>
692 </li>
693
694
695
696
697
698
699
700 <li class="md-nav__item">
701 <a href="../../../javascript/new-api_ajax/" class="md-nav__link">
702 Ajax
703 </a>
704 </li>
705
706
707
708
709
710
711
712 <li class="md-nav__item">
713 <a href="../../../javascript/new-api_dialogs/" class="md-nav__link">
714 Dialogs
715 </a>
716 </li>
717
718
719
720
721
722
723
724 <li class="md-nav__item">
725 <a href="../../../javascript/new-api_browser/" class="md-nav__link">
726 Browser and Screen Sizes
727 </a>
728 </li>
729
730
731
732
733
734
735
736 <li class="md-nav__item">
737 <a href="../../../javascript/new-api_ui/" class="md-nav__link">
738 User Interface
739 </a>
740 </li>
741
742
743
744 </ul>
745 </nav>
746 </li>
747
748
749
750
751
752
753
754 <li class="md-nav__item">
755 <a href="../../../javascript/legacy-api/" class="md-nav__link">
756 Legacy API
757 </a>
758 </li>
759
760
761
762
763
764
765
766 <li class="md-nav__item">
767 <a href="../../../javascript/helper-functions/" class="md-nav__link">
768 Helper Functions
769 </a>
770 </li>
771
772
773
774
775
776
777
778 <li class="md-nav__item">
779 <a href="../../../javascript/code-snippets/" class="md-nav__link">
780 Code Snippets
781 </a>
782 </li>
783
784
785
786 </ul>
787 </nav>
788 </li>
789
790
791
792
793
794
795
796
797
798
799
800
801
802 <li class="md-nav__item md-nav__item--active md-nav__item--nested">
803
804
805 <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5" type="checkbox" id="__nav_5" checked>
806
807 <label class="md-nav__link" for="__nav_5">
808 Package Components
809 <span class="md-nav__icon md-icon"></span>
810 </label>
811 <nav class="md-nav" aria-label="Package Components" data-md-level="1">
812 <label class="md-nav__title" for="__nav_5">
813 <span class="md-nav__icon md-icon"></span>
814 Package Components
815 </label>
816 <ul class="md-nav__list" data-md-scrollfix>
817
818
819
820
821
822 <li class="md-nav__item">
823 <a href="../../package-xml/" class="md-nav__link">
824 package.xml
825 </a>
826 </li>
827
828
829
830
831
832
833
834
835
836
837 <li class="md-nav__item md-nav__item--active md-nav__item--nested">
838
839
840 <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_2" type="checkbox" id="__nav_5_2" checked>
841
842 <label class="md-nav__link" for="__nav_5_2">
843 PIPs
844 <span class="md-nav__icon md-icon"></span>
845 </label>
846 <nav class="md-nav" aria-label="PIPs" data-md-level="2">
847 <label class="md-nav__title" for="__nav_5_2">
848 <span class="md-nav__icon md-icon"></span>
849 PIPs
850 </label>
851 <ul class="md-nav__list" data-md-scrollfix>
852
853
854
855
856
857 <li class="md-nav__item">
858 <a href="../" class="md-nav__link">
859 Overview
860 </a>
861 </li>
862
863
864
865
866
867
868
869 <li class="md-nav__item">
870 <a href="../acl-option/" class="md-nav__link">
871 aclOption
872 </a>
873 </li>
874
875
876
877
878
879
880
881 <li class="md-nav__item">
882 <a href="../acp-menu/" class="md-nav__link">
883 acpMenu
884 </a>
885 </li>
886
887
888
889
890
891
892
893 <li class="md-nav__item">
894 <a href="../acp-search-provider/" class="md-nav__link">
895 acpSearchProvider
896 </a>
897 </li>
898
899
900
901
902
903
904
905 <li class="md-nav__item">
906 <a href="../acp-template/" class="md-nav__link">
907 acpTemplate
908 </a>
909 </li>
910
911
912
913
914
915
916
917 <li class="md-nav__item">
918 <a href="../bbcode/" class="md-nav__link">
919 bbcode
920 </a>
921 </li>
922
923
924
925
926
927
928
929 <li class="md-nav__item">
930 <a href="../box/" class="md-nav__link">
931 box
932 </a>
933 </li>
934
935
936
937
938
939
940
941 <li class="md-nav__item">
942 <a href="../clipboard-action/" class="md-nav__link">
943 clipboardAction
944 </a>
945 </li>
946
947
948
949
950
951
952
953 <li class="md-nav__item">
954 <a href="../core-object/" class="md-nav__link">
955 coreObject
956 </a>
957 </li>
958
959
960
961
962
963
964
965 <li class="md-nav__item">
966 <a href="../cronjob/" class="md-nav__link">
967 cronjob
968 </a>
969 </li>
970
971
972
973
974
975
976
977 <li class="md-nav__item">
978 <a href="../event-listener/" class="md-nav__link">
979 eventListener
980 </a>
981 </li>
982
983
984
985
986
987
988
989 <li class="md-nav__item">
990 <a href="../file/" class="md-nav__link">
991 file
992 </a>
993 </li>
994
995
996
997
998
999
1000
1001 <li class="md-nav__item">
1002 <a href="../language/" class="md-nav__link">
1003 language
1004 </a>
1005 </li>
1006
1007
1008
1009
1010
1011
1012
1013 <li class="md-nav__item">
1014 <a href="../media-provider/" class="md-nav__link">
1015 mediaProvider
1016 </a>
1017 </li>
1018
1019
1020
1021
1022
1023
1024
1025 <li class="md-nav__item">
1026 <a href="../menu/" class="md-nav__link">
1027 menu
1028 </a>
1029 </li>
1030
1031
1032
1033
1034
1035
1036
1037 <li class="md-nav__item">
1038 <a href="../menu-item/" class="md-nav__link">
1039 menuItem
1040 </a>
1041 </li>
1042
1043
1044
1045
1046
1047
1048
1049 <li class="md-nav__item">
1050 <a href="../object-type/" class="md-nav__link">
1051 objectType
1052 </a>
1053 </li>
1054
1055
1056
1057
1058
1059
1060
1061 <li class="md-nav__item">
1062 <a href="../object-type-definition/" class="md-nav__link">
1063 objectTypeDefinition
1064 </a>
1065 </li>
1066
1067
1068
1069
1070
1071
1072
1073 <li class="md-nav__item">
1074 <a href="../option/" class="md-nav__link">
1075 option
1076 </a>
1077 </li>
1078
1079
1080
1081
1082
1083
1084
1085 <li class="md-nav__item">
1086 <a href="../page/" class="md-nav__link">
1087 page
1088 </a>
1089 </li>
1090
1091
1092
1093
1094
1095
1096
1097 <li class="md-nav__item">
1098 <a href="../pip/" class="md-nav__link">
1099 pip
1100 </a>
1101 </li>
1102
1103
1104
1105
1106
1107
1108
1109 <li class="md-nav__item">
1110 <a href="../script/" class="md-nav__link">
1111 script
1112 </a>
1113 </li>
1114
1115
1116
1117
1118
1119
1120
1121 <li class="md-nav__item">
1122 <a href="../smiley/" class="md-nav__link">
1123 smiley
1124 </a>
1125 </li>
1126
1127
1128
1129
1130
1131
1132
1133 <li class="md-nav__item">
1134 <a href="../sql/" class="md-nav__link">
1135 sql
1136 </a>
1137 </li>
1138
1139
1140
1141
1142
1143
1144
1145 <li class="md-nav__item">
1146 <a href="../style/" class="md-nav__link">
1147 style
1148 </a>
1149 </li>
1150
1151
1152
1153
1154
1155
1156
1157 <li class="md-nav__item">
1158 <a href="../template/" class="md-nav__link">
1159 template
1160 </a>
1161 </li>
1162
1163
1164
1165
1166
1167
1168
1169 <li class="md-nav__item">
1170 <a href="../template-listener/" class="md-nav__link">
1171 templateListener
1172 </a>
1173 </li>
1174
1175
1176
1177
1178
1179
1180
1181 <li class="md-nav__item">
1182 <a href="../user-group-option/" class="md-nav__link">
1183 userGroupOption
1184 </a>
1185 </li>
1186
1187
1188
1189
1190
1191
1192
1193 <li class="md-nav__item">
1194 <a href="../user-menu/" class="md-nav__link">
1195 userMenu
1196 </a>
1197 </li>
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207 <li class="md-nav__item md-nav__item--active">
1208
1209 <input class="md-nav__toggle md-toggle" data-md-toggle="toc" type="checkbox" id="__toc">
1210
1211
1212
1213
1214 <label class="md-nav__link md-nav__link--active" for="__toc">
1215 userNotificationEvent
1216 <span class="md-nav__icon md-icon"></span>
1217 </label>
1218
1219 <a href="./" class="md-nav__link md-nav__link--active">
1220 userNotificationEvent
1221 </a>
1222
1223
1224 <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
1225
1226
1227
1228
1229
1230 <label class="md-nav__title" for="__toc">
1231 <span class="md-nav__icon md-icon"></span>
1232 Table of contents
1233 </label>
1234 <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
1235
1236 <li class="md-nav__item">
1237 <a href="#components" class="md-nav__link">
1238 Components
1239 </a>
1240
1241 <nav class="md-nav" aria-label="Components">
1242 <ul class="md-nav__list">
1243
1244 <li class="md-nav__item">
1245 <a href="#objecttype" class="md-nav__link">
1246 &lt;objectType&gt;
1247 </a>
1248
1249 </li>
1250
1251 <li class="md-nav__item">
1252 <a href="#classname" class="md-nav__link">
1253 &lt;classname&gt;
1254 </a>
1255
1256 </li>
1257
1258 <li class="md-nav__item">
1259 <a href="#preset" class="md-nav__link">
1260 &lt;preset&gt;
1261 </a>
1262
1263 </li>
1264
1265 <li class="md-nav__item">
1266 <a href="#presetmailnotificationtype" class="md-nav__link">
1267 &lt;presetmailnotificationtype&gt;
1268 </a>
1269
1270 </li>
1271
1272 <li class="md-nav__item">
1273 <a href="#options" class="md-nav__link">
1274 &lt;options&gt;
1275 </a>
1276
1277 </li>
1278
1279 <li class="md-nav__item">
1280 <a href="#permissions" class="md-nav__link">
1281 &lt;permissions&gt;
1282 </a>
1283
1284 </li>
1285
1286 </ul>
1287 </nav>
1288
1289 </li>
1290
1291 <li class="md-nav__item">
1292 <a href="#example" class="md-nav__link">
1293 Example
1294 </a>
1295
1296 </li>
1297
1298 </ul>
1299
1300 </nav>
1301
1302 </li>
1303
1304
1305
1306
1307
1308
1309
1310 <li class="md-nav__item">
1311 <a href="../user-option/" class="md-nav__link">
1312 userOption
1313 </a>
1314 </li>
1315
1316
1317
1318
1319
1320
1321
1322 <li class="md-nav__item">
1323 <a href="../user-profile-menu/" class="md-nav__link">
1324 userProfileMenu
1325 </a>
1326 </li>
1327
1328
1329
1330 </ul>
1331 </nav>
1332 </li>
1333
1334
1335
1336
1337
1338
1339
1340 <li class="md-nav__item">
1341 <a href="../../database-php-api/" class="md-nav__link">
1342 Database PHP API
1343 </a>
1344 </li>
1345
1346
1347
1348 </ul>
1349 </nav>
1350 </li>
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362 <li class="md-nav__item md-nav__item--nested">
1363
1364
1365 <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6" type="checkbox" id="__nav_6" >
1366
1367 <label class="md-nav__link" for="__nav_6">
1368 Migration
1369 <span class="md-nav__icon md-icon"></span>
1370 </label>
1371 <nav class="md-nav" aria-label="Migration" data-md-level="1">
1372 <label class="md-nav__title" for="__nav_6">
1373 <span class="md-nav__icon md-icon"></span>
1374 Migration
1375 </label>
1376 <ul class="md-nav__list" data-md-scrollfix>
1377
1378
1379
1380
1381
1382
1383 <li class="md-nav__item md-nav__item--nested">
1384
1385
1386 <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_1" type="checkbox" id="__nav_6_1" >
1387
1388 <label class="md-nav__link" for="__nav_6_1">
1389 Migrating from WSC 5.3
1390 <span class="md-nav__icon md-icon"></span>
1391 </label>
1392 <nav class="md-nav" aria-label="Migrating from WSC 5.3" data-md-level="2">
1393 <label class="md-nav__title" for="__nav_6_1">
1394 <span class="md-nav__icon md-icon"></span>
1395 Migrating from WSC 5.3
1396 </label>
1397 <ul class="md-nav__list" data-md-scrollfix>
1398
1399
1400
1401
1402
1403 <li class="md-nav__item">
1404 <a href="../../../migration/wsc53/php/" class="md-nav__link">
1405 PHP API
1406 </a>
1407 </li>
1408
1409
1410
1411
1412
1413
1414
1415 <li class="md-nav__item">
1416 <a href="../../../migration/wsc53/session/" class="md-nav__link">
1417 Session Handling and Authentication
1418 </a>
1419 </li>
1420
1421
1422
1423
1424
1425
1426
1427 <li class="md-nav__item">
1428 <a href="../../../migration/wsc53/javascript/" class="md-nav__link">
1429 JavaScript
1430 </a>
1431 </li>
1432
1433
1434
1435
1436
1437
1438
1439 <li class="md-nav__item">
1440 <a href="../../../migration/wsc53/templates/" class="md-nav__link">
1441 Templates
1442 </a>
1443 </li>
1444
1445
1446
1447
1448
1449
1450
1451 <li class="md-nav__item">
1452 <a href="../../../migration/wsc53/libraries/" class="md-nav__link">
1453 Third Party Libraries
1454 </a>
1455 </li>
1456
1457
1458
1459 </ul>
1460 </nav>
1461 </li>
1462
1463
1464
1465
1466
1467
1468
1469
1470 <li class="md-nav__item md-nav__item--nested">
1471
1472
1473 <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_2" type="checkbox" id="__nav_6_2" >
1474
1475 <label class="md-nav__link" for="__nav_6_2">
1476 Migrating from WSC 5.2
1477 <span class="md-nav__icon md-icon"></span>
1478 </label>
1479 <nav class="md-nav" aria-label="Migrating from WSC 5.2" data-md-level="2">
1480 <label class="md-nav__title" for="__nav_6_2">
1481 <span class="md-nav__icon md-icon"></span>
1482 Migrating from WSC 5.2
1483 </label>
1484 <ul class="md-nav__list" data-md-scrollfix>
1485
1486
1487
1488
1489
1490 <li class="md-nav__item">
1491 <a href="../../../migration/wsc52/php/" class="md-nav__link">
1492 PHP API
1493 </a>
1494 </li>
1495
1496
1497
1498
1499
1500
1501
1502 <li class="md-nav__item">
1503 <a href="../../../migration/wsc52/templates/" class="md-nav__link">
1504 Templates and Languages
1505 </a>
1506 </li>
1507
1508
1509
1510
1511
1512
1513
1514 <li class="md-nav__item">
1515 <a href="../../../migration/wsc52/libraries/" class="md-nav__link">
1516 Third Party Libraries
1517 </a>
1518 </li>
1519
1520
1521
1522 </ul>
1523 </nav>
1524 </li>
1525
1526
1527
1528
1529
1530
1531
1532
1533 <li class="md-nav__item md-nav__item--nested">
1534
1535
1536 <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_3" type="checkbox" id="__nav_6_3" >
1537
1538 <label class="md-nav__link" for="__nav_6_3">
1539 Migrating from WSC 3.1
1540 <span class="md-nav__icon md-icon"></span>
1541 </label>
1542 <nav class="md-nav" aria-label="Migrating from WSC 3.1" data-md-level="2">
1543 <label class="md-nav__title" for="__nav_6_3">
1544 <span class="md-nav__icon md-icon"></span>
1545 Migrating from WSC 3.1
1546 </label>
1547 <ul class="md-nav__list" data-md-scrollfix>
1548
1549
1550
1551
1552
1553 <li class="md-nav__item">
1554 <a href="../../../migration/wsc31/php/" class="md-nav__link">
1555 PHP API
1556 </a>
1557 </li>
1558
1559
1560
1561 </ul>
1562 </nav>
1563 </li>
1564
1565
1566
1567
1568
1569
1570
1571
1572 <li class="md-nav__item md-nav__item--nested">
1573
1574
1575 <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_4" type="checkbox" id="__nav_6_4" >
1576
1577 <label class="md-nav__link" for="__nav_6_4">
1578 Migrating from WSC 3.0
1579 <span class="md-nav__icon md-icon"></span>
1580 </label>
1581 <nav class="md-nav" aria-label="Migrating from WSC 3.0" data-md-level="2">
1582 <label class="md-nav__title" for="__nav_6_4">
1583 <span class="md-nav__icon md-icon"></span>
1584 Migrating from WSC 3.0
1585 </label>
1586 <ul class="md-nav__list" data-md-scrollfix>
1587
1588
1589
1590
1591
1592 <li class="md-nav__item">
1593 <a href="../../../migration/wsc30/php/" class="md-nav__link">
1594 PHP API
1595 </a>
1596 </li>
1597
1598
1599
1600
1601
1602
1603
1604 <li class="md-nav__item">
1605 <a href="../../../migration/wsc30/javascript/" class="md-nav__link">
1606 JavaScript API
1607 </a>
1608 </li>
1609
1610
1611
1612
1613
1614
1615
1616 <li class="md-nav__item">
1617 <a href="../../../migration/wsc30/templates/" class="md-nav__link">
1618 Templates
1619 </a>
1620 </li>
1621
1622
1623
1624
1625
1626
1627
1628 <li class="md-nav__item">
1629 <a href="../../../migration/wsc30/css/" class="md-nav__link">
1630 CSS
1631 </a>
1632 </li>
1633
1634
1635
1636
1637
1638
1639
1640 <li class="md-nav__item">
1641 <a href="../../../migration/wsc30/package/" class="md-nav__link">
1642 Package Components
1643 </a>
1644 </li>
1645
1646
1647
1648 </ul>
1649 </nav>
1650 </li>
1651
1652
1653
1654
1655
1656
1657
1658
1659 <li class="md-nav__item md-nav__item--nested">
1660
1661
1662 <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_5" type="checkbox" id="__nav_6_5" >
1663
1664 <label class="md-nav__link" for="__nav_6_5">
1665 Migrating from WCF 2.1
1666 <span class="md-nav__icon md-icon"></span>
1667 </label>
1668 <nav class="md-nav" aria-label="Migrating from WCF 2.1" data-md-level="2">
1669 <label class="md-nav__title" for="__nav_6_5">
1670 <span class="md-nav__icon md-icon"></span>
1671 Migrating from WCF 2.1
1672 </label>
1673 <ul class="md-nav__list" data-md-scrollfix>
1674
1675
1676
1677
1678
1679 <li class="md-nav__item">
1680 <a href="../../../migration/wcf21/php/" class="md-nav__link">
1681 PHP API
1682 </a>
1683 </li>
1684
1685
1686
1687
1688
1689
1690
1691 <li class="md-nav__item">
1692 <a href="../../../migration/wcf21/templates/" class="md-nav__link">
1693 Templates
1694 </a>
1695 </li>
1696
1697
1698
1699
1700
1701
1702
1703 <li class="md-nav__item">
1704 <a href="../../../migration/wcf21/css/" class="md-nav__link">
1705 CSS
1706 </a>
1707 </li>
1708
1709
1710
1711
1712
1713
1714
1715 <li class="md-nav__item">
1716 <a href="../../../migration/wcf21/package/" class="md-nav__link">
1717 Package Components
1718 </a>
1719 </li>
1720
1721
1722
1723 </ul>
1724 </nav>
1725 </li>
1726
1727
1728
1729 </ul>
1730 </nav>
1731 </li>
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743 <li class="md-nav__item md-nav__item--nested">
1744
1745
1746 <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_7" type="checkbox" id="__nav_7" >
1747
1748 <label class="md-nav__link" for="__nav_7">
1749 Tutorials
1750 <span class="md-nav__icon md-icon"></span>
1751 </label>
1752 <nav class="md-nav" aria-label="Tutorials" data-md-level="1">
1753 <label class="md-nav__title" for="__nav_7">
1754 <span class="md-nav__icon md-icon"></span>
1755 Tutorials
1756 </label>
1757 <ul class="md-nav__list" data-md-scrollfix>
1758
1759
1760
1761
1762
1763
1764 <li class="md-nav__item md-nav__item--nested">
1765
1766
1767 <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_7_1" type="checkbox" id="__nav_7_1" >
1768
1769 <label class="md-nav__link" for="__nav_7_1">
1770 Tutorial Series
1771 <span class="md-nav__icon md-icon"></span>
1772 </label>
1773 <nav class="md-nav" aria-label="Tutorial Series" data-md-level="2">
1774 <label class="md-nav__title" for="__nav_7_1">
1775 <span class="md-nav__icon md-icon"></span>
1776 Tutorial Series
1777 </label>
1778 <ul class="md-nav__list" data-md-scrollfix>
1779
1780
1781
1782
1783
1784 <li class="md-nav__item">
1785 <a href="../../../tutorial/series/overview/" class="md-nav__link">
1786 Overview
1787 </a>
1788 </li>
1789
1790
1791
1792
1793
1794
1795
1796 <li class="md-nav__item">
1797 <a href="../../../tutorial/series/part_1/" class="md-nav__link">
1798 Part 1
1799 </a>
1800 </li>
1801
1802
1803
1804
1805
1806
1807
1808 <li class="md-nav__item">
1809 <a href="../../../tutorial/series/part_2/" class="md-nav__link">
1810 Part 2
1811 </a>
1812 </li>
1813
1814
1815
1816
1817
1818
1819
1820 <li class="md-nav__item">
1821 <a href="../../../tutorial/series/part_3/" class="md-nav__link">
1822 Part 3
1823 </a>
1824 </li>
1825
1826
1827
1828 </ul>
1829 </nav>
1830 </li>
1831
1832
1833
1834 </ul>
1835 </nav>
1836 </li>
1837
1838
1839
1840 </ul>
1841 </nav>
1842 </div>
1843 </div>
1844 </div>
1845
1846
1847
1848 <div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
1849 <div class="md-sidebar__scrollwrap">
1850 <div class="md-sidebar__inner">
1851
1852 <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
1853
1854
1855
1856
1857
1858 <label class="md-nav__title" for="__toc">
1859 <span class="md-nav__icon md-icon"></span>
1860 Table of contents
1861 </label>
1862 <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
1863
1864 <li class="md-nav__item">
1865 <a href="#components" class="md-nav__link">
1866 Components
1867 </a>
1868
1869 <nav class="md-nav" aria-label="Components">
1870 <ul class="md-nav__list">
1871
1872 <li class="md-nav__item">
1873 <a href="#objecttype" class="md-nav__link">
1874 &lt;objectType&gt;
1875 </a>
1876
1877 </li>
1878
1879 <li class="md-nav__item">
1880 <a href="#classname" class="md-nav__link">
1881 &lt;classname&gt;
1882 </a>
1883
1884 </li>
1885
1886 <li class="md-nav__item">
1887 <a href="#preset" class="md-nav__link">
1888 &lt;preset&gt;
1889 </a>
1890
1891 </li>
1892
1893 <li class="md-nav__item">
1894 <a href="#presetmailnotificationtype" class="md-nav__link">
1895 &lt;presetmailnotificationtype&gt;
1896 </a>
1897
1898 </li>
1899
1900 <li class="md-nav__item">
1901 <a href="#options" class="md-nav__link">
1902 &lt;options&gt;
1903 </a>
1904
1905 </li>
1906
1907 <li class="md-nav__item">
1908 <a href="#permissions" class="md-nav__link">
1909 &lt;permissions&gt;
1910 </a>
1911
1912 </li>
1913
1914 </ul>
1915 </nav>
1916
1917 </li>
1918
1919 <li class="md-nav__item">
1920 <a href="#example" class="md-nav__link">
1921 Example
1922 </a>
1923
1924 </li>
1925
1926 </ul>
1927
1928 </nav>
1929 </div>
1930 </div>
1931 </div>
1932
1933
1934 <div class="md-content" data-md-component="content">
1935 <article class="md-content__inner md-typeset">
1936
1937
1938
1939 <h1 id="user-notification-event-package-installation-plugin">User Notification Event Package Installation Plugin<a class="headerlink" href="#user-notification-event-package-installation-plugin" title="Permanent link">#</a></h1>
1940 <p>Registers new user notification events.</p>
1941 <h2 id="components">Components<a class="headerlink" href="#components" title="Permanent link">#</a></h2>
1942 <p>Each package installation plugin is described as an <code>&lt;event&gt;</code> element with the mandatory child <code>&lt;name&gt;</code>.</p>
1943 <h3 id="objecttype"><code>&lt;objectType&gt;</code><a class="headerlink" href="#objecttype" title="Permanent link">#</a></h3>
1944 <div class="admonition warning">
1945 <p class="admonition-title">The <code>(name, objectType)</code> pair must be unique.</p>
1946 </div>
1947 <p>The given object type must implement the <code>com.woltlab.wcf.notification.objectType</code> definition.</p>
1948 <h3 id="classname"><code>&lt;classname&gt;</code><a class="headerlink" href="#classname" title="Permanent link">#</a></h3>
1949 <p>The name of the class providing the event's behaviour,
1950 the class has to implement the <code>wcf\system\user\notification\event\IUserNotificationEvent</code> interface.</p>
1951 <h3 id="preset"><code>&lt;preset&gt;</code><a class="headerlink" href="#preset" title="Permanent link">#</a></h3>
1952 <p>Defines whether this event is enabled by default.</p>
1953 <h3 id="presetmailnotificationtype"><code>&lt;presetmailnotificationtype&gt;</code><a class="headerlink" href="#presetmailnotificationtype" title="Permanent link">#</a></h3>
1954 <div class="admonition info">
1955 <p class="admonition-title">Avoid using this option, as sending unsolicited mail can be seen as spamming.</p>
1956 </div>
1957 <p>One of <code>instant</code> or <code>daily</code>.
1958 Defines whether this type of email notifications is enabled by default.</p>
1959 <h3 id="options"><code>&lt;options&gt;</code><a class="headerlink" href="#options" title="Permanent link">#</a></h3>
1960 <p><span class="label label-info">Optional</span></p>
1961 <p>The options element can contain a comma-separated list of options of which at least one needs to be enabled for the notification type to be available.</p>
1962 <h3 id="permissions"><code>&lt;permissions&gt;</code><a class="headerlink" href="#permissions" title="Permanent link">#</a></h3>
1963 <p><span class="label label-info">Optional</span></p>
1964 <p>The permissions element can contain a comma-separated list of permissions of which the active user needs to have at least one for the notification type to be available.</p>
1965 <h2 id="example">Example<a class="headerlink" href="#example" title="Permanent link">#</a></h2>
1966 <div class="highlight"><pre><span></span><code><span class="cp">&lt;?xml version=&quot;1.0&quot; encoding=&quot;UTF-8&quot;?&gt;</span>
1967 <span class="nt">&lt;data</span> <span class="na">xmlns=</span><span class="s">&quot;http://www.woltlab.com&quot;</span> <span class="na">xmlns:xsi=</span><span class="s">&quot;http://www.w3.org/2001/XMLSchema-instance&quot;</span> <span class="na">xsi:schemaLocation=</span><span class="s">&quot;http://www.woltlab.com http://www.woltlab.com/XSD/2019/userNotificationEvent.xsd&quot;</span><span class="nt">&gt;</span>
1968 <span class="nt">&lt;import&gt;</span>
1969 <span class="nt">&lt;event&gt;</span>
1970 <span class="nt">&lt;name&gt;</span>like<span class="nt">&lt;/name&gt;</span>
1971 <span class="nt">&lt;objecttype&gt;</span>com.woltlab.example.comment.like.notification<span class="nt">&lt;/objecttype&gt;</span>
1972 <span class="nt">&lt;classname&gt;</span>wcf\system\user\notification\event\ExampleCommentLikeUserNotificationEvent<span class="nt">&lt;/classname&gt;</span>
1973 <span class="nt">&lt;preset&gt;</span>1<span class="nt">&lt;/preset&gt;</span>
1974 <span class="nt">&lt;options&gt;</span>module_like<span class="nt">&lt;/options&gt;</span>
1975 <span class="nt">&lt;/event&gt;</span>
1976 <span class="nt">&lt;/import&gt;</span>
1977 <span class="nt">&lt;/data&gt;</span>
1978 </code></pre></div>
1979
1980
1981
1982
1983
1984
1985
1986 </article>
1987 </div>
1988 </div>
1989 </main>
1990
1991
1992 <footer class="md-footer">
1993
1994 <nav class="md-footer__inner md-grid" aria-label="Footer">
1995
1996 <a href="../user-menu/" class="md-footer__link md-footer__link--prev" rel="prev">
1997 <div class="md-footer__button md-icon">
1998 <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11h12z"/></svg>
1999 </div>
2000 <div class="md-footer__title">
2001 <div class="md-ellipsis">
2002 <span class="md-footer__direction">
2003 Previous
2004 </span>
2005 userMenu
2006 </div>
2007 </div>
2008 </a>
2009
2010
2011 <a href="../user-option/" class="md-footer__link md-footer__link--next" rel="next">
2012 <div class="md-footer__title">
2013 <div class="md-ellipsis">
2014 <span class="md-footer__direction">
2015 Next
2016 </span>
2017 userOption
2018 </div>
2019 </div>
2020 <div class="md-footer__button md-icon">
2021 <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M4 11v2h12l-5.5 5.5 1.42 1.42L19.84 12l-7.92-7.92L10.5 5.5 16 11H4z"/></svg>
2022 </div>
2023 </a>
2024
2025 </nav>
2026
2027 <div class="md-footer-meta md-typeset">
2028 <div class="md-footer-meta__inner md-grid">
2029 <div class="md-footer-copyright">
2030
2031 <div class="md-footer-copyright__highlight">
2032 Copyright © 2020 WoltLab GmbH
2033 </div>
2034
2035 Made with
2036 <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
2037 Material for MkDocs
2038 </a>
2039
2040 </div>
2041 <div class="md-footer-copyright">
2042 <a href="https://www.woltlab.com/legal-notice/">Legal Notice</a>
2043 <a href="https://www.woltlab.com/privacy-policy/">Privacy Policy</a>
2044 </div>
2045 </div>
2046 </div>
2047 </footer>
2048
2049 </div>
2050 <div class="md-dialog" data-md-component="dialog">
2051 <div class="md-dialog__inner md-typeset"></div>
2052 </div>
2053 <script id="__config" type="application/json">{"base": "../../..", "features": [], "translations": {"clipboard.copy": "Copy to clipboard", "clipboard.copied": "Copied to clipboard", "search.config.lang": "en", "search.config.pipeline": "trimmer, stopWordFilter", "search.config.separator": "[\\s\\-]+", "search.placeholder": "Search", "search.result.placeholder": "Type to start searching", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.term.missing": "Missing"}, "search": "../../../assets/javascripts/workers/search.fb4a9340.min.js", "version": {"provider": "mike"}}</script>
2054
2055
2056 <script src="../../../assets/javascripts/bundle.5cf3e710.min.js"></script>
2057
2058
2059 </body>
2060 </html>