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