6.0/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         <link rel="canonical" href="https://docs.woltlab.com/6.0/package/pip/user-notification-event/">
  12
  13
  14         <link rel="prev" href="../user-menu/">
  15
  16
  17         <link rel="next" href="../user-option/">
  18
  19       <link rel="icon" href="../../../assets/default.favicon.ico">
  20       <meta name="generator" content="mkdocs-1.4.2, mkdocs-material-9.0.15">
  21
  22
  23
  24         <title>userNotificationEvent - WoltLab Suite Documentation</title>
  25
  26
  27
  28       <link rel="stylesheet" href="../../../assets/stylesheets/main.113286f1.min.css">
  29
  30
  31         <link rel="stylesheet" href="../../../assets/stylesheets/palette.a0c5b2b5.min.css">
  32
  33
  34
  35
  36
  37
  38
  39
  40
  41       <link rel="stylesheet" href="../../../stylesheets/extra.css">
  42
  43     <script>__md_scope=new URL("../../..",location),__md_hash=e=>[...e].reduce((e,_)=>(e<<5)-e+_.charCodeAt(0),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
  44
  45
  46
  47
  48
  49
  50   </head>
  51
  52
  53
  54
  55
  56
  57
  58     <body dir="ltr" data-md-color-scheme="default" data-md-color-primary="teal" data-md-color-accent="">
  59
  60
  61
  62     <input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
  63     <input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
  64     <label class="md-overlay" for="__drawer"></label>
  65     <div data-md-component="skip">
  66
  67
  68         <a href="#user-notification-event-package-installation-plugin" class="md-skip">
  69           Skip to content
  70         </a>
  71
  72     </div>
  73     <div data-md-component="announce">
  74
  75         <aside class="md-banner">
  76           <div class="md-banner__inner md-grid md-typeset">
  77
  78
  79     <a href="https://www.woltlab.com">Back to <strong>woltlab.com</strong></a>
  80
  81           </div>
  82
  83         </aside>
  84
  85     </div>
  86
  87       <div data-md-color-scheme="default" data-md-component="outdated" hidden>
  88
  89       </div>
  90
  91
  92
  93
  94 <header class="md-header" data-md-component="header">
  95   <nav class="md-header__inner md-grid" aria-label="Header">
  96     <a href="../../.." title="WoltLab Suite Documentation" class="md-header__button md-logo" aria-label="WoltLab Suite Documentation" data-md-component="logo">
  97
  98   <img src="../../../assets/logo.png" alt="logo">
  99
 100     </a>
 101     <label class="md-header__button md-icon" for="__drawer">
 102       <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3 6h18v2H3V6m0 5h18v2H3v-2m0 5h18v2H3v-2Z"/></svg>
 103     </label>
 104     <div class="md-header__title" data-md-component="header-title">
 105       <div class="md-header__ellipsis">
 106         <div class="md-header__topic">
 107           <span class="md-ellipsis">
 108             WoltLab Suite Documentation
 109           </span>
 110         </div>
 111         <div class="md-header__topic" data-md-component="header-topic">
 112           <span class="md-ellipsis">
 113
 114               userNotificationEvent
 115
 116           </span>
 117         </div>
 118       </div>
 119     </div>
 120
 121
 122
 123       <label class="md-header__button md-icon" for="__search">
 124         <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>
 125       </label>
 126       <div class="md-search" data-md-component="search" role="dialog">
 127   <label class="md-search__overlay" for="__search"></label>
 128   <div class="md-search__inner" role="search">
 129     <form class="md-search__form" name="search">
 130       <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" required>
 131       <label class="md-search__icon md-icon" for="__search">
 132         <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>
 133         <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>
 134       </label>
 135       <nav class="md-search__options" aria-label="Search">
 136
 137         <button type="reset" class="md-search__icon md-icon" title="Clear" aria-label="Clear" tabindex="-1">
 138           <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>
 139         </button>
 140       </nav>
 141
 142     </form>
 143     <div class="md-search__output">
 144       <div class="md-search__scrollwrap" data-md-scrollfix>
 145         <div class="md-search-result" data-md-component="search-result">
 146           <div class="md-search-result__meta">
 147             Initializing search
 148           </div>
 149           <ol class="md-search-result__list" role="presentation"></ol>
 150         </div>
 151       </div>
 152     </div>
 153   </div>
 154 </div>
 155
 156
 157       <div class="md-header__source">
 158         <a href="https://github.com/WoltLab/docs.woltlab.com/" title="Go to repository" class="md-source" data-md-component="source">
 159   <div class="md-source__icon md-icon">
 160
 161     <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 6.3.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2023 Fonticons, Inc.--><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>
 162   </div>
 163   <div class="md-source__repository">
 164     GitHub
 165   </div>
 166 </a>
 167       </div>
 168
 169   </nav>
 170
 171 </header>
 172
 173     <div class="md-container" data-md-component="container">
 174
 175
 176
 177
 178
 179
 180       <main class="md-main" data-md-component="main">
 181         <div class="md-main__inner md-grid">
 182
 183
 184
 185               <div class="md-sidebar md-sidebar--primary" data-md-component="sidebar" data-md-type="navigation" >
 186                 <div class="md-sidebar__scrollwrap">
 187                   <div class="md-sidebar__inner">
 188
 189
 190
 191 <nav class="md-nav md-nav--primary" aria-label="Navigation" data-md-level="0">
 192   <label class="md-nav__title" for="__drawer">
 193     <a href="../../.." title="WoltLab Suite Documentation" class="md-nav__button md-logo" aria-label="WoltLab Suite Documentation" data-md-component="logo">
 194
 195   <img src="../../../assets/logo.png" alt="logo">
 196
 197     </a>
 198     WoltLab Suite Documentation
 199   </label>
 200
 201     <div class="md-nav__source">
 202       <a href="https://github.com/WoltLab/docs.woltlab.com/" title="Go to repository" class="md-source" data-md-component="source">
 203   <div class="md-source__icon md-icon">
 204
 205     <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 6.3.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2023 Fonticons, Inc.--><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>
 206   </div>
 207   <div class="md-source__repository">
 208     GitHub
 209   </div>
 210 </a>
 211     </div>
 212
 213   <ul class="md-nav__list" data-md-scrollfix>
 214
 215
 216
 217
 218
 219
 220
 221
 222     <li class="md-nav__item">
 223       <a href="../../../getting-started/" class="md-nav__link">
 224         Getting Started
 225       </a>
 226     </li>
 227
 228
 229
 230
 231
 232
 233
 234
 235
 236
 237
 238     <li class="md-nav__item md-nav__item--nested">
 239
 240
 241
 242
 243       <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2" >
 244
 245
 246
 247         <label class="md-nav__link" for="__nav_2" id="__nav_2_label" tabindex="0">
 248           PHP API
 249           <span class="md-nav__icon md-icon"></span>
 250         </label>
 251
 252       <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_2_label" aria-expanded="false">
 253         <label class="md-nav__title" for="__nav_2">
 254           <span class="md-nav__icon md-icon"></span>
 255           PHP API
 256         </label>
 257         <ul class="md-nav__list" data-md-scrollfix>
 258
 259
 260
 261
 262
 263
 264     <li class="md-nav__item">
 265       <a href="../../../php/pages/" class="md-nav__link">
 266         Pages
 267       </a>
 268     </li>
 269
 270
 271
 272
 273
 274
 275
 276
 277
 278     <li class="md-nav__item">
 279       <a href="../../../php/database-objects/" class="md-nav__link">
 280         Database Objects
 281       </a>
 282     </li>
 283
 284
 285
 286
 287
 288
 289
 290
 291
 292     <li class="md-nav__item">
 293       <a href="../../../php/database-access/" class="md-nav__link">
 294         Database Access
 295       </a>
 296     </li>
 297
 298
 299
 300
 301
 302
 303
 304
 305
 306     <li class="md-nav__item">
 307       <a href="../../../php/exceptions/" class="md-nav__link">
 308         Exceptions
 309       </a>
 310     </li>
 311
 312
 313
 314
 315
 316
 317
 318
 319
 320
 321     <li class="md-nav__item md-nav__item--nested">
 322
 323
 324
 325
 326       <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2_5" >
 327
 328
 329
 330         <label class="md-nav__link" for="__nav_2_5" id="__nav_2_5_label" tabindex="0">
 331           API
 332           <span class="md-nav__icon md-icon"></span>
 333         </label>
 334
 335       <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_2_5_label" aria-expanded="false">
 336         <label class="md-nav__title" for="__nav_2_5">
 337           <span class="md-nav__icon md-icon"></span>
 338           API
 339         </label>
 340         <ul class="md-nav__list" data-md-scrollfix>
 341
 342
 343
 344
 345
 346
 347
 348     <li class="md-nav__item md-nav__item--nested">
 349
 350
 351
 352
 353       <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2_5_1" >
 354
 355
 356
 357         <label class="md-nav__link" for="__nav_2_5_1" id="__nav_2_5_1_label" tabindex="0">
 358           Caches
 359           <span class="md-nav__icon md-icon"></span>
 360         </label>
 361
 362       <nav class="md-nav" data-md-level="3" aria-labelledby="__nav_2_5_1_label" aria-expanded="false">
 363         <label class="md-nav__title" for="__nav_2_5_1">
 364           <span class="md-nav__icon md-icon"></span>
 365           Caches
 366         </label>
 367         <ul class="md-nav__list" data-md-scrollfix>
 368
 369
 370
 371
 372
 373
 374     <li class="md-nav__item">
 375       <a href="../../../php/api/caches/" class="md-nav__link">
 376         Overview
 377       </a>
 378     </li>
 379
 380
 381
 382
 383
 384
 385
 386
 387
 388     <li class="md-nav__item">
 389       <a href="../../../php/api/caches_persistent-caches/" class="md-nav__link">
 390         Persistent Caches
 391       </a>
 392     </li>
 393
 394
 395
 396
 397
 398
 399
 400
 401
 402     <li class="md-nav__item">
 403       <a href="../../../php/api/caches_runtime-caches/" class="md-nav__link">
 404         Runtime Caches
 405       </a>
 406     </li>
 407
 408
 409
 410
 411         </ul>
 412       </nav>
 413     </li>
 414
 415
 416
 417
 418
 419
 420
 421
 422
 423     <li class="md-nav__item">
 424       <a href="../../../php/api/comments/" class="md-nav__link">
 425         Comments
 426       </a>
 427     </li>
 428
 429
 430
 431
 432
 433
 434
 435
 436
 437     <li class="md-nav__item">
 438       <a href="../../../php/api/cronjobs/" class="md-nav__link">
 439         Cronjobs
 440       </a>
 441     </li>
 442
 443
 444
 445
 446
 447
 448
 449
 450
 451     <li class="md-nav__item">
 452       <a href="../../../php/api/events/" class="md-nav__link">
 453         Events
 454       </a>
 455     </li>
 456
 457
 458
 459
 460
 461
 462
 463
 464
 465
 466     <li class="md-nav__item md-nav__item--nested">
 467
 468
 469
 470
 471       <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2_5_5" >
 472
 473
 474
 475         <label class="md-nav__link" for="__nav_2_5_5" id="__nav_2_5_5_label" tabindex="0">
 476           Form Builder
 477           <span class="md-nav__icon md-icon"></span>
 478         </label>
 479
 480       <nav class="md-nav" data-md-level="3" aria-labelledby="__nav_2_5_5_label" aria-expanded="false">
 481         <label class="md-nav__title" for="__nav_2_5_5">
 482           <span class="md-nav__icon md-icon"></span>
 483           Form Builder
 484         </label>
 485         <ul class="md-nav__list" data-md-scrollfix>
 486
 487
 488
 489
 490
 491
 492     <li class="md-nav__item">
 493       <a href="../../../php/api/form_builder/overview/" class="md-nav__link">
 494         Overview
 495       </a>
 496     </li>
 497
 498
 499
 500
 501
 502
 503
 504
 505
 506     <li class="md-nav__item">
 507       <a href="../../../php/api/form_builder/structure/" class="md-nav__link">
 508         Structure
 509       </a>
 510     </li>
 511
 512
 513
 514
 515
 516
 517
 518
 519
 520     <li class="md-nav__item">
 521       <a href="../../../php/api/form_builder/form_fields/" class="md-nav__link">
 522         Fields
 523       </a>
 524     </li>
 525
 526
 527
 528
 529
 530
 531
 532
 533
 534     <li class="md-nav__item">
 535       <a href="../../../php/api/form_builder/validation_data/" class="md-nav__link">
 536         Validation and Data
 537       </a>
 538     </li>
 539
 540
 541
 542
 543
 544
 545
 546
 547
 548     <li class="md-nav__item">
 549       <a href="../../../php/api/form_builder/dependencies/" class="md-nav__link">
 550         Dependencies
 551       </a>
 552     </li>
 553
 554
 555
 556
 557         </ul>
 558       </nav>
 559     </li>
 560
 561
 562
 563
 564
 565
 566
 567
 568
 569     <li class="md-nav__item">
 570       <a href="../../../php/api/package_installation_plugins/" class="md-nav__link">
 571         Package Installation Plugins
 572       </a>
 573     </li>
 574
 575
 576
 577
 578
 579
 580
 581
 582
 583     <li class="md-nav__item">
 584       <a href="../../../php/api/user_activity_points/" class="md-nav__link">
 585         User Activity Points
 586       </a>
 587     </li>
 588
 589
 590
 591
 592
 593
 594
 595
 596
 597     <li class="md-nav__item">
 598       <a href="../../../php/api/user_notifications/" class="md-nav__link">
 599         User Notifications
 600       </a>
 601     </li>
 602
 603
 604
 605
 606
 607
 608
 609
 610
 611     <li class="md-nav__item">
 612       <a href="../../../php/api/sitemaps/" class="md-nav__link">
 613         Sitemaps
 614       </a>
 615     </li>
 616
 617
 618
 619
 620         </ul>
 621       </nav>
 622     </li>
 623
 624
 625
 626
 627
 628
 629
 630
 631
 632     <li class="md-nav__item">
 633       <a href="../../../php/code-style/" class="md-nav__link">
 634         Code Style
 635       </a>
 636     </li>
 637
 638
 639
 640
 641
 642
 643
 644
 645
 646     <li class="md-nav__item">
 647       <a href="../../../php/apps/" class="md-nav__link">
 648         Apps
 649       </a>
 650     </li>
 651
 652
 653
 654
 655
 656
 657
 658
 659
 660     <li class="md-nav__item">
 661       <a href="../../../php/gdpr/" class="md-nav__link">
 662         GDPR
 663       </a>
 664     </li>
 665
 666
 667
 668
 669         </ul>
 670       </nav>
 671     </li>
 672
 673
 674
 675
 676
 677
 678
 679
 680
 681
 682
 683     <li class="md-nav__item md-nav__item--nested">
 684
 685
 686
 687
 688       <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_3" >
 689
 690
 691
 692         <label class="md-nav__link" for="__nav_3" id="__nav_3_label" tabindex="0">
 693           Languages, Templates & CSS
 694           <span class="md-nav__icon md-icon"></span>
 695         </label>
 696
 697       <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_3_label" aria-expanded="false">
 698         <label class="md-nav__title" for="__nav_3">
 699           <span class="md-nav__icon md-icon"></span>
 700           Languages, Templates & CSS
 701         </label>
 702         <ul class="md-nav__list" data-md-scrollfix>
 703
 704
 705
 706
 707
 708
 709     <li class="md-nav__item">
 710       <a href="../../../view/languages/" class="md-nav__link">
 711         Languages
 712       </a>
 713     </li>
 714
 715
 716
 717
 718
 719
 720
 721
 722
 723     <li class="md-nav__item">
 724       <a href="../../../view/templates/" class="md-nav__link">
 725         Templates
 726       </a>
 727     </li>
 728
 729
 730
 731
 732
 733
 734
 735
 736
 737     <li class="md-nav__item">
 738       <a href="../../../view/template-plugins/" class="md-nav__link">
 739         Template Plugins
 740       </a>
 741     </li>
 742
 743
 744
 745
 746
 747
 748
 749
 750
 751     <li class="md-nav__item">
 752       <a href="../../../view/css/" class="md-nav__link">
 753         CSS
 754       </a>
 755     </li>
 756
 757
 758
 759
 760         </ul>
 761       </nav>
 762     </li>
 763
 764
 765
 766
 767
 768
 769
 770
 771
 772
 773
 774     <li class="md-nav__item md-nav__item--nested">
 775
 776
 777
 778
 779       <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4" >
 780
 781
 782
 783         <label class="md-nav__link" for="__nav_4" id="__nav_4_label" tabindex="0">
 784           TypeScript and JavaScript API
 785           <span class="md-nav__icon md-icon"></span>
 786         </label>
 787
 788       <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="false">
 789         <label class="md-nav__title" for="__nav_4">
 790           <span class="md-nav__icon md-icon"></span>
 791           TypeScript and JavaScript API
 792         </label>
 793         <ul class="md-nav__list" data-md-scrollfix>
 794
 795
 796
 797
 798
 799
 800     <li class="md-nav__item">
 801       <a href="../../../javascript/general-usage/" class="md-nav__link">
 802         General Usage
 803       </a>
 804     </li>
 805
 806
 807
 808
 809
 810
 811
 812
 813
 814     <li class="md-nav__item">
 815       <a href="../../../javascript/typescript/" class="md-nav__link">
 816         TypeScript
 817       </a>
 818     </li>
 819
 820
 821
 822
 823
 824
 825
 826
 827
 828
 829     <li class="md-nav__item md-nav__item--nested">
 830
 831
 832
 833
 834       <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4_3" >
 835
 836
 837
 838         <label class="md-nav__link" for="__nav_4_3" id="__nav_4_3_label" tabindex="0">
 839           Components
 840           <span class="md-nav__icon md-icon"></span>
 841         </label>
 842
 843       <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_4_3_label" aria-expanded="false">
 844         <label class="md-nav__title" for="__nav_4_3">
 845           <span class="md-nav__icon md-icon"></span>
 846           Components
 847         </label>
 848         <ul class="md-nav__list" data-md-scrollfix>
 849
 850
 851
 852
 853
 854
 855     <li class="md-nav__item">
 856       <a href="../../../javascript/components_confirmation/" class="md-nav__link">
 857         Confirmation
 858       </a>
 859     </li>
 860
 861
 862
 863
 864
 865
 866
 867
 868
 869     <li class="md-nav__item">
 870       <a href="../../../javascript/components_dialog/" class="md-nav__link">
 871         Dialog
 872       </a>
 873     </li>
 874
 875
 876
 877
 878
 879
 880
 881
 882
 883     <li class="md-nav__item">
 884       <a href="../../../javascript/components_google_maps/" class="md-nav__link">
 885         Google Maps
 886       </a>
 887     </li>
 888
 889
 890
 891
 892
 893
 894
 895
 896
 897     <li class="md-nav__item">
 898       <a href="../../../javascript/components_pagination/" class="md-nav__link">
 899         Pagination
 900       </a>
 901     </li>
 902
 903
 904
 905
 906         </ul>
 907       </nav>
 908     </li>
 909
 910
 911
 912
 913
 914
 915
 916
 917
 918
 919     <li class="md-nav__item md-nav__item--nested">
 920
 921
 922
 923
 924       <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4_4" >
 925
 926
 927
 928         <label class="md-nav__link" for="__nav_4_4" id="__nav_4_4_label" tabindex="0">
 929           New API
 930           <span class="md-nav__icon md-icon"></span>
 931         </label>
 932
 933       <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_4_4_label" aria-expanded="false">
 934         <label class="md-nav__title" for="__nav_4_4">
 935           <span class="md-nav__icon md-icon"></span>
 936           New API
 937         </label>
 938         <ul class="md-nav__list" data-md-scrollfix>
 939
 940
 941
 942
 943
 944
 945     <li class="md-nav__item">
 946       <a href="../../../javascript/new-api_writing-a-module/" class="md-nav__link">
 947         Writing a module
 948       </a>
 949     </li>
 950
 951
 952
 953
 954
 955
 956
 957
 958
 959     <li class="md-nav__item">
 960       <a href="../../../javascript/new-api_core/" class="md-nav__link">
 961         Core Functions
 962       </a>
 963     </li>
 964
 965
 966
 967
 968
 969
 970
 971
 972
 973     <li class="md-nav__item">
 974       <a href="../../../javascript/new-api_dom/" class="md-nav__link">
 975         DOM
 976       </a>
 977     </li>
 978
 979
 980
 981
 982
 983
 984
 985
 986
 987     <li class="md-nav__item">
 988       <a href="../../../javascript/new-api_events/" class="md-nav__link">
 989         Event Handling
 990       </a>
 991     </li>
 992
 993
 994
 995
 996
 997
 998
 999
1000
1001     <li class="md-nav__item">
1002       <a href="../../../javascript/new-api_ajax/" class="md-nav__link">
1003         Ajax
1004       </a>
1005     </li>
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015     <li class="md-nav__item">
1016       <a href="../../../javascript/new-api_dialogs/" class="md-nav__link">
1017         Dialogs
1018       </a>
1019     </li>
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029     <li class="md-nav__item">
1030       <a href="../../../javascript/new-api_browser/" class="md-nav__link">
1031         Browser and Screen Sizes
1032       </a>
1033     </li>
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043     <li class="md-nav__item">
1044       <a href="../../../javascript/new-api_ui/" class="md-nav__link">
1045         User Interface
1046       </a>
1047     </li>
1048
1049
1050
1051
1052         </ul>
1053       </nav>
1054     </li>
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064     <li class="md-nav__item">
1065       <a href="../../../javascript/legacy-api/" class="md-nav__link">
1066         Legacy API
1067       </a>
1068     </li>
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078     <li class="md-nav__item">
1079       <a href="../../../javascript/code-snippets/" class="md-nav__link">
1080         Code Snippets
1081       </a>
1082     </li>
1083
1084
1085
1086
1087         </ul>
1088       </nav>
1089     </li>
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103     <li class="md-nav__item md-nav__item--active md-nav__item--nested">
1104
1105
1106
1107
1108       <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_5" checked>
1109
1110
1111
1112         <label class="md-nav__link" for="__nav_5" id="__nav_5_label" tabindex="0">
1113           Package Components
1114           <span class="md-nav__icon md-icon"></span>
1115         </label>
1116
1117       <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_5_label" aria-expanded="true">
1118         <label class="md-nav__title" for="__nav_5">
1119           <span class="md-nav__icon md-icon"></span>
1120           Package Components
1121         </label>
1122         <ul class="md-nav__list" data-md-scrollfix>
1123
1124
1125
1126
1127
1128
1129     <li class="md-nav__item">
1130       <a href="../../package-xml/" class="md-nav__link">
1131         package.xml
1132       </a>
1133     </li>
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146     <li class="md-nav__item md-nav__item--active md-nav__item--nested">
1147
1148
1149
1150
1151       <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_5_2" checked>
1152
1153
1154
1155         <label class="md-nav__link" for="__nav_5_2" id="__nav_5_2_label" tabindex="0">
1156           PIPs
1157           <span class="md-nav__icon md-icon"></span>
1158         </label>
1159
1160       <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_5_2_label" aria-expanded="true">
1161         <label class="md-nav__title" for="__nav_5_2">
1162           <span class="md-nav__icon md-icon"></span>
1163           PIPs
1164         </label>
1165         <ul class="md-nav__list" data-md-scrollfix>
1166
1167
1168
1169
1170
1171
1172     <li class="md-nav__item">
1173       <a href="../" class="md-nav__link">
1174         Overview
1175       </a>
1176     </li>
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186     <li class="md-nav__item">
1187       <a href="../acl-option/" class="md-nav__link">
1188         aclOption
1189       </a>
1190     </li>
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200     <li class="md-nav__item">
1201       <a href="../acp-menu/" class="md-nav__link">
1202         acpMenu
1203       </a>
1204     </li>
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214     <li class="md-nav__item">
1215       <a href="../acp-search-provider/" class="md-nav__link">
1216         acpSearchProvider
1217       </a>
1218     </li>
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228     <li class="md-nav__item">
1229       <a href="../acp-template/" class="md-nav__link">
1230         acpTemplate
1231       </a>
1232     </li>
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242     <li class="md-nav__item">
1243       <a href="../acp-template-delete/" class="md-nav__link">
1244         acpTemplateDelete
1245       </a>
1246     </li>
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256     <li class="md-nav__item">
1257       <a href="../bbcode/" class="md-nav__link">
1258         bbcode
1259       </a>
1260     </li>
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270     <li class="md-nav__item">
1271       <a href="../box/" class="md-nav__link">
1272         box
1273       </a>
1274     </li>
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284     <li class="md-nav__item">
1285       <a href="../clipboard-action/" class="md-nav__link">
1286         clipboardAction
1287       </a>
1288     </li>
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298     <li class="md-nav__item">
1299       <a href="../core-object/" class="md-nav__link">
1300         coreObject
1301       </a>
1302     </li>
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312     <li class="md-nav__item">
1313       <a href="../cronjob/" class="md-nav__link">
1314         cronjob
1315       </a>
1316     </li>
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326     <li class="md-nav__item">
1327       <a href="../database/" class="md-nav__link">
1328         database
1329       </a>
1330     </li>
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340     <li class="md-nav__item">
1341       <a href="../event-listener/" class="md-nav__link">
1342         eventListener
1343       </a>
1344     </li>
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354     <li class="md-nav__item">
1355       <a href="../file/" class="md-nav__link">
1356         file
1357       </a>
1358     </li>
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368     <li class="md-nav__item">
1369       <a href="../file-delete/" class="md-nav__link">
1370         fileDelete
1371       </a>
1372     </li>
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382     <li class="md-nav__item">
1383       <a href="../language/" class="md-nav__link">
1384         language
1385       </a>
1386     </li>
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396     <li class="md-nav__item">
1397       <a href="../media-provider/" class="md-nav__link">
1398         mediaProvider
1399       </a>
1400     </li>
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410     <li class="md-nav__item">
1411       <a href="../menu/" class="md-nav__link">
1412         menu
1413       </a>
1414     </li>
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424     <li class="md-nav__item">
1425       <a href="../menu-item/" class="md-nav__link">
1426         menuItem
1427       </a>
1428     </li>
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438     <li class="md-nav__item">
1439       <a href="../object-type/" class="md-nav__link">
1440         objectType
1441       </a>
1442     </li>
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452     <li class="md-nav__item">
1453       <a href="../object-type-definition/" class="md-nav__link">
1454         objectTypeDefinition
1455       </a>
1456     </li>
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466     <li class="md-nav__item">
1467       <a href="../option/" class="md-nav__link">
1468         option
1469       </a>
1470     </li>
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480     <li class="md-nav__item">
1481       <a href="../page/" class="md-nav__link">
1482         page
1483       </a>
1484     </li>
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494     <li class="md-nav__item">
1495       <a href="../pip/" class="md-nav__link">
1496         pip
1497       </a>
1498     </li>
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508     <li class="md-nav__item">
1509       <a href="../script/" class="md-nav__link">
1510         script
1511       </a>
1512     </li>
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522     <li class="md-nav__item">
1523       <a href="../smiley/" class="md-nav__link">
1524         smiley
1525       </a>
1526     </li>
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536     <li class="md-nav__item">
1537       <a href="../sql/" class="md-nav__link">
1538         sql
1539       </a>
1540     </li>
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550     <li class="md-nav__item">
1551       <a href="../style/" class="md-nav__link">
1552         style
1553       </a>
1554     </li>
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564     <li class="md-nav__item">
1565       <a href="../template/" class="md-nav__link">
1566         template
1567       </a>
1568     </li>
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578     <li class="md-nav__item">
1579       <a href="../template-delete/" class="md-nav__link">
1580         templateDelete
1581       </a>
1582     </li>
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592     <li class="md-nav__item">
1593       <a href="../template-listener/" class="md-nav__link">
1594         templateListener
1595       </a>
1596     </li>
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606     <li class="md-nav__item">
1607       <a href="../user-group-option/" class="md-nav__link">
1608         userGroupOption
1609       </a>
1610     </li>
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620     <li class="md-nav__item">
1621       <a href="../user-menu/" class="md-nav__link">
1622         userMenu
1623       </a>
1624     </li>
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636     <li class="md-nav__item md-nav__item--active">
1637
1638       <input class="md-nav__toggle md-toggle" type="checkbox" id="__toc">
1639
1640
1641
1642
1643
1644         <label class="md-nav__link md-nav__link--active" for="__toc">
1645           userNotificationEvent
1646           <span class="md-nav__icon md-icon"></span>
1647         </label>
1648
1649       <a href="./" class="md-nav__link md-nav__link--active">
1650         userNotificationEvent
1651       </a>
1652
1653
1654
1655 <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
1656
1657
1658
1659
1660
1661
1662     <label class="md-nav__title" for="__toc">
1663       <span class="md-nav__icon md-icon"></span>
1664       Table of contents
1665     </label>
1666     <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
1667
1668         <li class="md-nav__item">
1669   <a href="#components" class="md-nav__link">
1670     Components
1671   </a>
1672
1673     <nav class="md-nav" aria-label="Components">
1674       <ul class="md-nav__list">
1675
1676           <li class="md-nav__item">
1677   <a href="#objecttype" class="md-nav__link">
1678     &lt;objectType&gt;
1679   </a>
1680
1681 </li>
1682
1683           <li class="md-nav__item">
1684   <a href="#classname" class="md-nav__link">
1685     &lt;classname&gt;
1686   </a>
1687
1688 </li>
1689
1690           <li class="md-nav__item">
1691   <a href="#preset" class="md-nav__link">
1692     &lt;preset&gt;
1693   </a>
1694
1695 </li>
1696
1697           <li class="md-nav__item">
1698   <a href="#presetmailnotificationtype" class="md-nav__link">
1699     &lt;presetmailnotificationtype&gt;
1700   </a>
1701
1702 </li>
1703
1704           <li class="md-nav__item">
1705   <a href="#options" class="md-nav__link">
1706     &lt;options&gt;
1707   </a>
1708
1709 </li>
1710
1711           <li class="md-nav__item">
1712   <a href="#permissions" class="md-nav__link">
1713     &lt;permissions&gt;
1714   </a>
1715
1716 </li>
1717
1718       </ul>
1719     </nav>
1720
1721 </li>
1722
1723         <li class="md-nav__item">
1724   <a href="#example" class="md-nav__link">
1725     Example
1726   </a>
1727
1728 </li>
1729
1730     </ul>
1731
1732 </nav>
1733
1734     </li>
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744     <li class="md-nav__item">
1745       <a href="../user-option/" class="md-nav__link">
1746         userOption
1747       </a>
1748     </li>
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758     <li class="md-nav__item">
1759       <a href="../user-profile-menu/" class="md-nav__link">
1760         userProfileMenu
1761       </a>
1762     </li>
1763
1764
1765
1766
1767         </ul>
1768       </nav>
1769     </li>
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779     <li class="md-nav__item">
1780       <a href="../../database-php-api/" class="md-nav__link">
1781         Database PHP API
1782       </a>
1783     </li>
1784
1785
1786
1787
1788         </ul>
1789       </nav>
1790     </li>
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802     <li class="md-nav__item md-nav__item--nested">
1803
1804
1805
1806
1807       <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_6" >
1808
1809
1810
1811         <label class="md-nav__link" for="__nav_6" id="__nav_6_label" tabindex="0">
1812           Migration
1813           <span class="md-nav__icon md-icon"></span>
1814         </label>
1815
1816       <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_6_label" aria-expanded="false">
1817         <label class="md-nav__title" for="__nav_6">
1818           <span class="md-nav__icon md-icon"></span>
1819           Migration
1820         </label>
1821         <ul class="md-nav__list" data-md-scrollfix>
1822
1823
1824
1825
1826
1827
1828
1829     <li class="md-nav__item md-nav__item--nested">
1830
1831
1832
1833
1834       <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_6_1" >
1835
1836
1837
1838         <label class="md-nav__link" for="__nav_6_1" id="__nav_6_1_label" tabindex="0">
1839           From WoltLab Suite 5.5
1840           <span class="md-nav__icon md-icon"></span>
1841         </label>
1842
1843       <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_1_label" aria-expanded="false">
1844         <label class="md-nav__title" for="__nav_6_1">
1845           <span class="md-nav__icon md-icon"></span>
1846           From WoltLab Suite 5.5
1847         </label>
1848         <ul class="md-nav__list" data-md-scrollfix>
1849
1850
1851
1852
1853
1854
1855     <li class="md-nav__item">
1856       <a href="../../../migration/wsc55/php/" class="md-nav__link">
1857         PHP API
1858       </a>
1859     </li>
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869     <li class="md-nav__item">
1870       <a href="../../../migration/wsc55/javascript/" class="md-nav__link">
1871         TypeScript and JavaScript
1872       </a>
1873     </li>
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883     <li class="md-nav__item">
1884       <a href="../../../migration/wsc55/templates/" class="md-nav__link">
1885         Templates
1886       </a>
1887     </li>
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897     <li class="md-nav__item">
1898       <a href="../../../migration/wsc55/icons/" class="md-nav__link">
1899         Icons
1900       </a>
1901     </li>
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911     <li class="md-nav__item">
1912       <a href="../../../migration/wsc55/dialogs/" class="md-nav__link">
1913         Dialogs
1914       </a>
1915     </li>
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925     <li class="md-nav__item">
1926       <a href="../../../migration/wsc55/libraries/" class="md-nav__link">
1927         Third Party Libraries
1928       </a>
1929     </li>
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939     <li class="md-nav__item">
1940       <a href="../../../migration/wsc55/deprecations_removals/" class="md-nav__link">
1941         Deprecations and Removals
1942       </a>
1943     </li>
1944
1945
1946
1947
1948         </ul>
1949       </nav>
1950     </li>
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961     <li class="md-nav__item md-nav__item--nested">
1962
1963
1964
1965
1966       <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_6_2" >
1967
1968
1969
1970         <label class="md-nav__link" for="__nav_6_2" id="__nav_6_2_label" tabindex="0">
1971           From WoltLab Suite 5.4
1972           <span class="md-nav__icon md-icon"></span>
1973         </label>
1974
1975       <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_2_label" aria-expanded="false">
1976         <label class="md-nav__title" for="__nav_6_2">
1977           <span class="md-nav__icon md-icon"></span>
1978           From WoltLab Suite 5.4
1979         </label>
1980         <ul class="md-nav__list" data-md-scrollfix>
1981
1982
1983
1984
1985
1986
1987     <li class="md-nav__item">
1988       <a href="../../../migration/wsc54/php/" class="md-nav__link">
1989         PHP API
1990       </a>
1991     </li>
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001     <li class="md-nav__item">
2002       <a href="../../../migration/wsc54/javascript/" class="md-nav__link">
2003         TypeScript and JavaScript
2004       </a>
2005     </li>
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015     <li class="md-nav__item">
2016       <a href="../../../migration/wsc54/templates/" class="md-nav__link">
2017         Templates
2018       </a>
2019     </li>
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029     <li class="md-nav__item">
2030       <a href="../../../migration/wsc54/libraries/" class="md-nav__link">
2031         Third Party Libraries
2032       </a>
2033     </li>
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043     <li class="md-nav__item">
2044       <a href="../../../migration/wsc54/deprecations_removals/" class="md-nav__link">
2045         Deprecations and Removals
2046       </a>
2047     </li>
2048
2049
2050
2051
2052         </ul>
2053       </nav>
2054     </li>
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065     <li class="md-nav__item md-nav__item--nested">
2066
2067
2068
2069
2070       <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_6_3" >
2071
2072
2073
2074         <label class="md-nav__link" for="__nav_6_3" id="__nav_6_3_label" tabindex="0">
2075           From WoltLab Suite 5.3
2076           <span class="md-nav__icon md-icon"></span>
2077         </label>
2078
2079       <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_3_label" aria-expanded="false">
2080         <label class="md-nav__title" for="__nav_6_3">
2081           <span class="md-nav__icon md-icon"></span>
2082           From WoltLab Suite 5.3
2083         </label>
2084         <ul class="md-nav__list" data-md-scrollfix>
2085
2086
2087
2088
2089
2090
2091     <li class="md-nav__item">
2092       <a href="../../../migration/wsc53/php/" class="md-nav__link">
2093         PHP API
2094       </a>
2095     </li>
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105     <li class="md-nav__item">
2106       <a href="../../../migration/wsc53/session/" class="md-nav__link">
2107         Session Handling and Authentication
2108       </a>
2109     </li>
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119     <li class="md-nav__item">
2120       <a href="../../../migration/wsc53/javascript/" class="md-nav__link">
2121         TypeScript and JavaScript
2122       </a>
2123     </li>
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133     <li class="md-nav__item">
2134       <a href="../../../migration/wsc53/templates/" class="md-nav__link">
2135         Templates
2136       </a>
2137     </li>
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147     <li class="md-nav__item">
2148       <a href="../../../migration/wsc53/libraries/" class="md-nav__link">
2149         Third Party Libraries
2150       </a>
2151     </li>
2152
2153
2154
2155
2156         </ul>
2157       </nav>
2158     </li>
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169     <li class="md-nav__item md-nav__item--nested">
2170
2171
2172
2173
2174       <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_6_4" >
2175
2176
2177
2178         <label class="md-nav__link" for="__nav_6_4" id="__nav_6_4_label" tabindex="0">
2179           From WoltLab Suite 5.2
2180           <span class="md-nav__icon md-icon"></span>
2181         </label>
2182
2183       <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_4_label" aria-expanded="false">
2184         <label class="md-nav__title" for="__nav_6_4">
2185           <span class="md-nav__icon md-icon"></span>
2186           From WoltLab Suite 5.2
2187         </label>
2188         <ul class="md-nav__list" data-md-scrollfix>
2189
2190
2191
2192
2193
2194
2195     <li class="md-nav__item">
2196       <a href="../../../migration/wsc52/php/" class="md-nav__link">
2197         PHP API
2198       </a>
2199     </li>
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209     <li class="md-nav__item">
2210       <a href="../../../migration/wsc52/templates/" class="md-nav__link">
2211         Templates and Languages
2212       </a>
2213     </li>
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223     <li class="md-nav__item">
2224       <a href="../../../migration/wsc52/libraries/" class="md-nav__link">
2225         Third Party Libraries
2226       </a>
2227     </li>
2228
2229
2230
2231
2232         </ul>
2233       </nav>
2234     </li>
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245     <li class="md-nav__item md-nav__item--nested">
2246
2247
2248
2249
2250       <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_6_5" >
2251
2252
2253
2254         <label class="md-nav__link" for="__nav_6_5" id="__nav_6_5_label" tabindex="0">
2255           From WoltLab Suite 3.1
2256           <span class="md-nav__icon md-icon"></span>
2257         </label>
2258
2259       <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_5_label" aria-expanded="false">
2260         <label class="md-nav__title" for="__nav_6_5">
2261           <span class="md-nav__icon md-icon"></span>
2262           From WoltLab Suite 3.1
2263         </label>
2264         <ul class="md-nav__list" data-md-scrollfix>
2265
2266
2267
2268
2269
2270
2271     <li class="md-nav__item">
2272       <a href="../../../migration/wsc31/php/" class="md-nav__link">
2273         PHP API
2274       </a>
2275     </li>
2276
2277
2278
2279
2280         </ul>
2281       </nav>
2282     </li>
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293     <li class="md-nav__item md-nav__item--nested">
2294
2295
2296
2297
2298       <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_6_6" >
2299
2300
2301
2302         <label class="md-nav__link" for="__nav_6_6" id="__nav_6_6_label" tabindex="0">
2303           From WoltLab Suite 3.0
2304           <span class="md-nav__icon md-icon"></span>
2305         </label>
2306
2307       <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_6_label" aria-expanded="false">
2308         <label class="md-nav__title" for="__nav_6_6">
2309           <span class="md-nav__icon md-icon"></span>
2310           From WoltLab Suite 3.0
2311         </label>
2312         <ul class="md-nav__list" data-md-scrollfix>
2313
2314
2315
2316
2317
2318
2319     <li class="md-nav__item">
2320       <a href="../../../migration/wsc30/php/" class="md-nav__link">
2321         PHP API
2322       </a>
2323     </li>
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333     <li class="md-nav__item">
2334       <a href="../../../migration/wsc30/javascript/" class="md-nav__link">
2335         JavaScript API
2336       </a>
2337     </li>
2338
2339
2340
2341
2342
2343
2344
2345
2346
2347     <li class="md-nav__item">
2348       <a href="../../../migration/wsc30/templates/" class="md-nav__link">
2349         Templates
2350       </a>
2351     </li>
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361     <li class="md-nav__item">
2362       <a href="../../../migration/wsc30/css/" class="md-nav__link">
2363         CSS
2364       </a>
2365     </li>
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375     <li class="md-nav__item">
2376       <a href="../../../migration/wsc30/package/" class="md-nav__link">
2377         Package Components
2378       </a>
2379     </li>
2380
2381
2382
2383
2384         </ul>
2385       </nav>
2386     </li>
2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397     <li class="md-nav__item md-nav__item--nested">
2398
2399
2400
2401
2402       <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_6_7" >
2403
2404
2405
2406         <label class="md-nav__link" for="__nav_6_7" id="__nav_6_7_label" tabindex="0">
2407           From WCF 2.1
2408           <span class="md-nav__icon md-icon"></span>
2409         </label>
2410
2411       <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_7_label" aria-expanded="false">
2412         <label class="md-nav__title" for="__nav_6_7">
2413           <span class="md-nav__icon md-icon"></span>
2414           From WCF 2.1
2415         </label>
2416         <ul class="md-nav__list" data-md-scrollfix>
2417
2418
2419
2420
2421
2422
2423     <li class="md-nav__item">
2424       <a href="../../../migration/wcf21/php/" class="md-nav__link">
2425         PHP API
2426       </a>
2427     </li>
2428
2429
2430
2431
2432
2433
2434
2435
2436
2437     <li class="md-nav__item">
2438       <a href="../../../migration/wcf21/templates/" class="md-nav__link">
2439         Templates
2440       </a>
2441     </li>
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451     <li class="md-nav__item">
2452       <a href="../../../migration/wcf21/css/" class="md-nav__link">
2453         CSS
2454       </a>
2455     </li>
2456
2457
2458
2459
2460
2461
2462
2463
2464
2465     <li class="md-nav__item">
2466       <a href="../../../migration/wcf21/package/" class="md-nav__link">
2467         Package Components
2468       </a>
2469     </li>
2470
2471
2472
2473
2474         </ul>
2475       </nav>
2476     </li>
2477
2478
2479
2480
2481         </ul>
2482       </nav>
2483     </li>
2484
2485
2486
2487
2488
2489
2490
2491
2492
2493
2494
2495     <li class="md-nav__item md-nav__item--nested">
2496
2497
2498
2499
2500       <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_7" >
2501
2502
2503
2504         <label class="md-nav__link" for="__nav_7" id="__nav_7_label" tabindex="0">
2505           Tutorials
2506           <span class="md-nav__icon md-icon"></span>
2507         </label>
2508
2509       <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_7_label" aria-expanded="false">
2510         <label class="md-nav__title" for="__nav_7">
2511           <span class="md-nav__icon md-icon"></span>
2512           Tutorials
2513         </label>
2514         <ul class="md-nav__list" data-md-scrollfix>
2515
2516
2517
2518
2519
2520
2521
2522     <li class="md-nav__item md-nav__item--nested">
2523
2524
2525
2526
2527       <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_7_1" >
2528
2529
2530
2531         <label class="md-nav__link" for="__nav_7_1" id="__nav_7_1_label" tabindex="0">
2532           Tutorial Series
2533           <span class="md-nav__icon md-icon"></span>
2534         </label>
2535
2536       <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_7_1_label" aria-expanded="false">
2537         <label class="md-nav__title" for="__nav_7_1">
2538           <span class="md-nav__icon md-icon"></span>
2539           Tutorial Series
2540         </label>
2541         <ul class="md-nav__list" data-md-scrollfix>
2542
2543
2544
2545
2546
2547
2548     <li class="md-nav__item">
2549       <a href="../../../tutorial/series/overview/" class="md-nav__link">
2550         Overview
2551       </a>
2552     </li>
2553
2554
2555
2556
2557
2558
2559
2560
2561
2562     <li class="md-nav__item">
2563       <a href="../../../tutorial/series/part_1/" class="md-nav__link">
2564         Part 1
2565       </a>
2566     </li>
2567
2568
2569
2570
2571
2572
2573
2574
2575
2576     <li class="md-nav__item">
2577       <a href="../../../tutorial/series/part_2/" class="md-nav__link">
2578         Part 2
2579       </a>
2580     </li>
2581
2582
2583
2584
2585
2586
2587
2588
2589
2590     <li class="md-nav__item">
2591       <a href="../../../tutorial/series/part_3/" class="md-nav__link">
2592         Part 3
2593       </a>
2594     </li>
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604     <li class="md-nav__item">
2605       <a href="../../../tutorial/series/part_4/" class="md-nav__link">
2606         Part 4
2607       </a>
2608     </li>
2609
2610
2611
2612
2613
2614
2615
2616
2617
2618     <li class="md-nav__item">
2619       <a href="../../../tutorial/series/part_5/" class="md-nav__link">
2620         Part 5
2621       </a>
2622     </li>
2623
2624
2625
2626
2627
2628
2629
2630
2631
2632     <li class="md-nav__item">
2633       <a href="../../../tutorial/series/part_6/" class="md-nav__link">
2634         Part 6
2635       </a>
2636     </li>
2637
2638
2639
2640
2641         </ul>
2642       </nav>
2643     </li>
2644
2645
2646
2647
2648         </ul>
2649       </nav>
2650     </li>
2651
2652
2653
2654   </ul>
2655 </nav>
2656                   </div>
2657                 </div>
2658               </div>
2659
2660
2661
2662               <div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
2663                 <div class="md-sidebar__scrollwrap">
2664                   <div class="md-sidebar__inner">
2665
2666
2667 <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
2668
2669
2670
2671
2672
2673
2674     <label class="md-nav__title" for="__toc">
2675       <span class="md-nav__icon md-icon"></span>
2676       Table of contents
2677     </label>
2678     <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
2679
2680         <li class="md-nav__item">
2681   <a href="#components" class="md-nav__link">
2682     Components
2683   </a>
2684
2685     <nav class="md-nav" aria-label="Components">
2686       <ul class="md-nav__list">
2687
2688           <li class="md-nav__item">
2689   <a href="#objecttype" class="md-nav__link">
2690     &lt;objectType&gt;
2691   </a>
2692
2693 </li>
2694
2695           <li class="md-nav__item">
2696   <a href="#classname" class="md-nav__link">
2697     &lt;classname&gt;
2698   </a>
2699
2700 </li>
2701
2702           <li class="md-nav__item">
2703   <a href="#preset" class="md-nav__link">
2704     &lt;preset&gt;
2705   </a>
2706
2707 </li>
2708
2709           <li class="md-nav__item">
2710   <a href="#presetmailnotificationtype" class="md-nav__link">
2711     &lt;presetmailnotificationtype&gt;
2712   </a>
2713
2714 </li>
2715
2716           <li class="md-nav__item">
2717   <a href="#options" class="md-nav__link">
2718     &lt;options&gt;
2719   </a>
2720
2721 </li>
2722
2723           <li class="md-nav__item">
2724   <a href="#permissions" class="md-nav__link">
2725     &lt;permissions&gt;
2726   </a>
2727
2728 </li>
2729
2730       </ul>
2731     </nav>
2732
2733 </li>
2734
2735         <li class="md-nav__item">
2736   <a href="#example" class="md-nav__link">
2737     Example
2738   </a>
2739
2740 </li>
2741
2742     </ul>
2743
2744 </nav>
2745                   </div>
2746                 </div>
2747               </div>
2748
2749
2750
2751             <div class="md-content" data-md-component="content">
2752               <article class="md-content__inner md-typeset">
2753
2754
2755
2756
2757
2758
2759
2760 <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>
2761 <p>Registers new user notification events.</p>
2762 <h2 id="components">Components<a class="headerlink" href="#components" title="Permanent link">#</a></h2>
2763 <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>
2764 <h3 id="objecttype"><code>&lt;objectType&gt;</code><a class="headerlink" href="#objecttype" title="Permanent link">#</a></h3>
2765 <div class="admonition warning">
2766 <p class="admonition-title">The <code>(name, objectType)</code> pair must be unique.</p>
2767 </div>
2768 <p>The given object type must implement the <code>com.woltlab.wcf.notification.objectType</code> definition.</p>
2769 <h3 id="classname"><code>&lt;classname&gt;</code><a class="headerlink" href="#classname" title="Permanent link">#</a></h3>
2770 <p>The name of the class providing the event's behaviour,
2771 the class has to implement the <code>wcf\system\user\notification\event\IUserNotificationEvent</code> interface.</p>
2772 <h3 id="preset"><code>&lt;preset&gt;</code><a class="headerlink" href="#preset" title="Permanent link">#</a></h3>
2773 <p>Defines whether this event is enabled by default.</p>
2774 <h3 id="presetmailnotificationtype"><code>&lt;presetmailnotificationtype&gt;</code><a class="headerlink" href="#presetmailnotificationtype" title="Permanent link">#</a></h3>
2775 <div class="admonition info">
2776 <p class="admonition-title">Avoid using this option, as sending unsolicited mail can be seen as spamming.</p>
2777 </div>
2778 <p>One of <code>instant</code> or <code>daily</code>.
2779 Defines whether this type of email notifications is enabled by default.</p>
2780 <h3 id="options"><code>&lt;options&gt;</code><a class="headerlink" href="#options" title="Permanent link">#</a></h3>
2781 <p><span class="label label-info">Optional</span></p>
2782 <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>
2783 <h3 id="permissions"><code>&lt;permissions&gt;</code><a class="headerlink" href="#permissions" title="Permanent link">#</a></h3>
2784 <p><span class="label label-info">Optional</span></p>
2785 <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>
2786 <h2 id="example">Example<a class="headerlink" href="#example" title="Permanent link">#</a></h2>
2787 <div class="highlight"><table class="highlighttable"><tr><th colspan="2" class="filename"><span class="filename">userNotificationEvent.xml <a class="codeBoxTitleGitHubLink" href="https://github.com/WoltLab/docs.woltlab.com/tree/6.0/snippets/package/pip/userNotificationEvent.xml" title="View on GitHub"><span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3.9 12c0-1.71 1.39-3.1 3.1-3.1h4V7H7a5 5 0 0 0-5 5 5 5 0 0 0 5 5h4v-1.9H7c-1.71 0-3.1-1.39-3.1-3.1M8 13h8v-2H8v2m9-6h-4v1.9h4c1.71 0 3.1 1.39 3.1 3.1 0 1.71-1.39 3.1-3.1 3.1h-4V17h4a5 5 0 0 0 5-5 5 5 0 0 0-5-5Z"/></svg></span></a></span></th></tr><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"> 1</span>
2788 <span class="normal"> 2</span>
2789 <span class="normal"> 3</span>
2790 <span class="normal"> 4</span>
2791 <span class="normal"> 5</span>
2792 <span class="normal"> 6</span>
2793 <span class="normal"> 7</span>
2794 <span class="normal"> 8</span>
2795 <span class="normal"> 9</span>
2796 <span class="normal">10</span>
2797 <span class="normal">11</span>
2798 <span class="normal">12</span></pre></div></td><td class="code"><div><pre><span></span><code><span class="cp">&lt;?xml version=&quot;1.0&quot; encoding=&quot;UTF-8&quot;?&gt;</span>
2799 <span class="nt">&lt;data</span><span class="w"> </span><span class="na">xmlns=</span><span class="s">&quot;http://www.woltlab.com&quot;</span><span class="w"> </span><span class="na">xmlns:xsi=</span><span class="s">&quot;http://www.w3.org/2001/XMLSchema-instance&quot;</span><span class="w"> </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>
2800 <span class="w">    </span><span class="nt">&lt;import&gt;</span>
2801 <span class="w">        </span><span class="nt">&lt;event&gt;</span>
2802 <span class="w">            </span><span class="nt">&lt;name&gt;</span>like<span class="nt">&lt;/name&gt;</span>
2803 <span class="w">            </span><span class="nt">&lt;objecttype&gt;</span>com.woltlab.example.comment.like.notification<span class="nt">&lt;/objecttype&gt;</span>
2804 <span class="w">            </span><span class="nt">&lt;classname&gt;</span>wcf\system\user\notification\event\ExampleCommentLikeUserNotificationEvent<span class="nt">&lt;/classname&gt;</span>
2805 <span class="w">            </span><span class="nt">&lt;preset&gt;</span>1<span class="nt">&lt;/preset&gt;</span>
2806 <span class="w">            </span><span class="nt">&lt;options&gt;</span>module_like<span class="nt">&lt;/options&gt;</span>
2807 <span class="w">        </span><span class="nt">&lt;/event&gt;</span>
2808 <span class="w">    </span><span class="nt">&lt;/import&gt;</span>
2809 <span class="nt">&lt;/data&gt;</span>
2810 </code></pre></div></td></tr></table></div>
2811
2812   <hr>
2813 <div class="md-source-file">
2814   <small>
2815
2816       Last update:
2817       2021-04-23
2818
2819   </small>
2820 </div>
2821
2822
2823
2824
2825
2826
2827               </article>
2828             </div>
2829
2830
2831         </div>
2832
2833       </main>
2834
2835         <footer class="md-footer">
2836
2837   <div class="md-footer-meta md-typeset">
2838     <div class="md-footer-meta__inner md-grid">
2839       <div class="md-copyright">
2840
2841     <div class="md-copyright__highlight">
2842       Copyright © 2020 WoltLab GmbH
2843     </div>
2844
2845
2846     Made with
2847     <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
2848       Material for MkDocs
2849     </a>
2850
2851 </div>
2852
2853         <div class="md-copyright">
2854         <a href="https://www.woltlab.com/legal-notice/">Legal Notice</a>
2855         <a href="https://www.woltlab.com/privacy-policy/">Privacy Policy</a>
2856 </div>
2857
2858     </div>
2859   </div>
2860 </footer>
2861
2862     </div>
2863     <div class="md-dialog" data-md-component="dialog">
2864       <div class="md-dialog__inner md-typeset"></div>
2865     </div>
2866
2867     <script id="__config" type="application/json">{"base": "../../..", "features": ["navigation.tracking"], "search": "../../../assets/javascripts/workers/search.208ed371.min.js", "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": {"provider": "mike"}}</script>
2868
2869
2870       <script src="../../../assets/javascripts/bundle.2a6f1dda.min.js"></script>
2871
2872
2873   </body>
2874 </html>