6.1/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.1/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
  20       <link rel="icon" href="../../../assets/default.favicon.ico">
  21       <meta name="generator" content="mkdocs-1.5.2, mkdocs-material-9.2.8">
  22
  23
  24
  25         <title>userNotificationEvent - WoltLab Suite Documentation</title>
  26
  27
  28
  29       <link rel="stylesheet" href="../../../assets/stylesheets/main.046329b4.min.css">
  30
  31
  32         <link rel="stylesheet" href="../../../assets/stylesheets/palette.85d0ee34.min.css">
  33
  34
  35
  36
  37
  38
  39
  40
  41
  42
  43
  44
  45       <link rel="stylesheet" href="../../../stylesheets/extra.css">
  46
  47     <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>
  48
  49
  50
  51
  52
  53
  54   </head>
  55
  56
  57
  58
  59
  60
  61
  62     <body dir="ltr" data-md-color-scheme="default" data-md-color-primary="teal" data-md-color-accent="indigo">
  63
  64
  65
  66     <input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
  67     <input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
  68     <label class="md-overlay" for="__drawer"></label>
  69     <div data-md-component="skip">
  70
  71
  72         <a href="#user-notification-event-package-installation-plugin" class="md-skip">
  73           Skip to content
  74         </a>
  75
  76     </div>
  77     <div data-md-component="announce">
  78
  79         <aside class="md-banner">
  80           <div class="md-banner__inner md-grid md-typeset">
  81
  82
  83     <a href="https://www.woltlab.com">Back to <strong>woltlab.com</strong></a>
  84
  85           </div>
  86
  87         </aside>
  88
  89     </div>
  90
  91       <div data-md-color-scheme="default" data-md-component="outdated" hidden>
  92
  93       </div>
  94
  95
  96
  97
  98
  99
 100 <header class="md-header md-header--shadow" data-md-component="header">
 101   <nav class="md-header__inner md-grid" aria-label="Header">
 102     <a href="../../.." title="WoltLab Suite Documentation" class="md-header__button md-logo" aria-label="WoltLab Suite Documentation" data-md-component="logo">
 103
 104   <img src="../../../assets/logo.png" alt="logo">
 105
 106     </a>
 107     <label class="md-header__button md-icon" for="__drawer">
 108
 109       <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3 6h18v2H3V6m0 5h18v2H3v-2m0 5h18v2H3v-2Z"/></svg>
 110     </label>
 111     <div class="md-header__title" data-md-component="header-title">
 112       <div class="md-header__ellipsis">
 113         <div class="md-header__topic">
 114           <span class="md-ellipsis">
 115             WoltLab Suite Documentation
 116           </span>
 117         </div>
 118         <div class="md-header__topic" data-md-component="header-topic">
 119           <span class="md-ellipsis">
 120
 121               userNotificationEvent
 122
 123           </span>
 124         </div>
 125       </div>
 126     </div>
 127
 128
 129
 130
 131
 132       <label class="md-header__button md-icon" for="__search">
 133
 134         <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>
 135       </label>
 136       <div class="md-search" data-md-component="search" role="dialog">
 137   <label class="md-search__overlay" for="__search"></label>
 138   <div class="md-search__inner" role="search">
 139     <form class="md-search__form" name="search">
 140       <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>
 141       <label class="md-search__icon md-icon" for="__search">
 142
 143         <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>
 144
 145         <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>
 146       </label>
 147       <nav class="md-search__options" aria-label="Search">
 148
 149         <button type="reset" class="md-search__icon md-icon" title="Clear" aria-label="Clear" tabindex="-1">
 150
 151           <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>
 152         </button>
 153       </nav>
 154
 155     </form>
 156     <div class="md-search__output">
 157       <div class="md-search__scrollwrap" data-md-scrollfix>
 158         <div class="md-search-result" data-md-component="search-result">
 159           <div class="md-search-result__meta">
 160             Initializing search
 161           </div>
 162           <ol class="md-search-result__list" role="presentation"></ol>
 163         </div>
 164       </div>
 165     </div>
 166   </div>
 167 </div>
 168
 169
 170       <div class="md-header__source">
 171         <a href="https://github.com/WoltLab/docs.woltlab.com/" title="Go to repository" class="md-source" data-md-component="source">
 172   <div class="md-source__icon md-icon">
 173
 174     <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 6.4.2 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>
 175   </div>
 176   <div class="md-source__repository">
 177     GitHub
 178   </div>
 179 </a>
 180       </div>
 181
 182   </nav>
 183
 184 </header>
 185
 186     <div class="md-container" data-md-component="container">
 187
 188
 189
 190
 191
 192
 193       <main class="md-main" data-md-component="main">
 194         <div class="md-main__inner md-grid">
 195
 196
 197
 198               <div class="md-sidebar md-sidebar--primary" data-md-component="sidebar" data-md-type="navigation" >
 199                 <div class="md-sidebar__scrollwrap">
 200                   <div class="md-sidebar__inner">
 201
 202
 203
 204
 205 <nav class="md-nav md-nav--primary" aria-label="Navigation" data-md-level="0">
 206   <label class="md-nav__title" for="__drawer">
 207     <a href="../../.." title="WoltLab Suite Documentation" class="md-nav__button md-logo" aria-label="WoltLab Suite Documentation" data-md-component="logo">
 208
 209   <img src="../../../assets/logo.png" alt="logo">
 210
 211     </a>
 212     WoltLab Suite Documentation
 213   </label>
 214
 215     <div class="md-nav__source">
 216       <a href="https://github.com/WoltLab/docs.woltlab.com/" title="Go to repository" class="md-source" data-md-component="source">
 217   <div class="md-source__icon md-icon">
 218
 219     <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 6.4.2 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>
 220   </div>
 221   <div class="md-source__repository">
 222     GitHub
 223   </div>
 224 </a>
 225     </div>
 226
 227   <ul class="md-nav__list" data-md-scrollfix>
 228
 229
 230
 231
 232
 233
 234     <li class="md-nav__item">
 235       <a href="../../../getting-started/" class="md-nav__link">
 236
 237
 238   <span class="md-ellipsis">
 239     Getting Started
 240   </span>
 241
 242
 243       </a>
 244     </li>
 245
 246
 247
 248
 249
 250
 251
 252
 253
 254
 255
 256     <li class="md-nav__item md-nav__item--nested">
 257
 258
 259
 260
 261
 262         <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2" >
 263
 264           <label class="md-nav__link" for="__nav_2" id="__nav_2_label" tabindex="0">
 265
 266
 267   <span class="md-ellipsis">
 268     PHP API
 269   </span>
 270
 271
 272             <span class="md-nav__icon md-icon"></span>
 273           </label>
 274
 275         <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_2_label" aria-expanded="false">
 276           <label class="md-nav__title" for="__nav_2">
 277             <span class="md-nav__icon md-icon"></span>
 278             PHP API
 279           </label>
 280           <ul class="md-nav__list" data-md-scrollfix>
 281
 282
 283
 284
 285
 286
 287     <li class="md-nav__item">
 288       <a href="../../../php/pages/" class="md-nav__link">
 289
 290
 291   <span class="md-ellipsis">
 292     Pages
 293   </span>
 294
 295
 296       </a>
 297     </li>
 298
 299
 300
 301
 302
 303
 304
 305
 306
 307     <li class="md-nav__item">
 308       <a href="../../../php/database-objects/" class="md-nav__link">
 309
 310
 311   <span class="md-ellipsis">
 312     Database Objects
 313   </span>
 314
 315
 316       </a>
 317     </li>
 318
 319
 320
 321
 322
 323
 324
 325
 326
 327     <li class="md-nav__item">
 328       <a href="../../../php/database-access/" class="md-nav__link">
 329
 330
 331   <span class="md-ellipsis">
 332     Database Access
 333   </span>
 334
 335
 336       </a>
 337     </li>
 338
 339
 340
 341
 342
 343
 344
 345
 346
 347     <li class="md-nav__item">
 348       <a href="../../../php/exceptions/" class="md-nav__link">
 349
 350
 351   <span class="md-ellipsis">
 352     Exceptions
 353   </span>
 354
 355
 356       </a>
 357     </li>
 358
 359
 360
 361
 362
 363
 364
 365
 366
 367
 368
 369
 370     <li class="md-nav__item md-nav__item--nested">
 371
 372
 373
 374
 375
 376         <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2_5" >
 377
 378           <label class="md-nav__link" for="__nav_2_5" id="__nav_2_5_label" tabindex="0">
 379
 380
 381   <span class="md-ellipsis">
 382     API
 383   </span>
 384
 385
 386             <span class="md-nav__icon md-icon"></span>
 387           </label>
 388
 389         <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_2_5_label" aria-expanded="false">
 390           <label class="md-nav__title" for="__nav_2_5">
 391             <span class="md-nav__icon md-icon"></span>
 392             API
 393           </label>
 394           <ul class="md-nav__list" data-md-scrollfix>
 395
 396
 397
 398
 399
 400
 401
 402
 403
 404     <li class="md-nav__item md-nav__item--nested">
 405
 406
 407
 408
 409
 410         <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2_5_1" >
 411
 412           <label class="md-nav__link" for="__nav_2_5_1" id="__nav_2_5_1_label" tabindex="0">
 413
 414
 415   <span class="md-ellipsis">
 416     Caches
 417   </span>
 418
 419
 420             <span class="md-nav__icon md-icon"></span>
 421           </label>
 422
 423         <nav class="md-nav" data-md-level="3" aria-labelledby="__nav_2_5_1_label" aria-expanded="false">
 424           <label class="md-nav__title" for="__nav_2_5_1">
 425             <span class="md-nav__icon md-icon"></span>
 426             Caches
 427           </label>
 428           <ul class="md-nav__list" data-md-scrollfix>
 429
 430
 431
 432
 433
 434
 435     <li class="md-nav__item">
 436       <a href="../../../php/api/caches/" class="md-nav__link">
 437
 438
 439   <span class="md-ellipsis">
 440     Overview
 441   </span>
 442
 443
 444       </a>
 445     </li>
 446
 447
 448
 449
 450
 451
 452
 453
 454
 455     <li class="md-nav__item">
 456       <a href="../../../php/api/caches_persistent-caches/" class="md-nav__link">
 457
 458
 459   <span class="md-ellipsis">
 460     Persistent Caches
 461   </span>
 462
 463
 464       </a>
 465     </li>
 466
 467
 468
 469
 470
 471
 472
 473
 474
 475     <li class="md-nav__item">
 476       <a href="../../../php/api/caches_runtime-caches/" class="md-nav__link">
 477
 478
 479   <span class="md-ellipsis">
 480     Runtime Caches
 481   </span>
 482
 483
 484       </a>
 485     </li>
 486
 487
 488
 489
 490           </ul>
 491         </nav>
 492
 493     </li>
 494
 495
 496
 497
 498
 499
 500
 501
 502
 503     <li class="md-nav__item">
 504       <a href="../../../php/api/comments/" class="md-nav__link">
 505
 506
 507   <span class="md-ellipsis">
 508     Comments
 509   </span>
 510
 511
 512       </a>
 513     </li>
 514
 515
 516
 517
 518
 519
 520
 521
 522
 523     <li class="md-nav__item">
 524       <a href="../../../php/api/cronjobs/" class="md-nav__link">
 525
 526
 527   <span class="md-ellipsis">
 528     Cronjobs
 529   </span>
 530
 531
 532       </a>
 533     </li>
 534
 535
 536
 537
 538
 539
 540
 541
 542
 543     <li class="md-nav__item">
 544       <a href="../../../php/api/events/" class="md-nav__link">
 545
 546
 547   <span class="md-ellipsis">
 548     Events
 549   </span>
 550
 551
 552       </a>
 553     </li>
 554
 555
 556
 557
 558
 559
 560
 561
 562
 563
 564
 565
 566     <li class="md-nav__item md-nav__item--nested">
 567
 568
 569
 570
 571
 572         <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2_5_5" >
 573
 574           <label class="md-nav__link" for="__nav_2_5_5" id="__nav_2_5_5_label" tabindex="0">
 575
 576
 577   <span class="md-ellipsis">
 578     Form Builder
 579   </span>
 580
 581
 582             <span class="md-nav__icon md-icon"></span>
 583           </label>
 584
 585         <nav class="md-nav" data-md-level="3" aria-labelledby="__nav_2_5_5_label" aria-expanded="false">
 586           <label class="md-nav__title" for="__nav_2_5_5">
 587             <span class="md-nav__icon md-icon"></span>
 588             Form Builder
 589           </label>
 590           <ul class="md-nav__list" data-md-scrollfix>
 591
 592
 593
 594
 595
 596
 597     <li class="md-nav__item">
 598       <a href="../../../php/api/form_builder/overview/" class="md-nav__link">
 599
 600
 601   <span class="md-ellipsis">
 602     Overview
 603   </span>
 604
 605
 606       </a>
 607     </li>
 608
 609
 610
 611
 612
 613
 614
 615
 616
 617     <li class="md-nav__item">
 618       <a href="../../../php/api/form_builder/structure/" class="md-nav__link">
 619
 620
 621   <span class="md-ellipsis">
 622     Structure
 623   </span>
 624
 625
 626       </a>
 627     </li>
 628
 629
 630
 631
 632
 633
 634
 635
 636
 637     <li class="md-nav__item">
 638       <a href="../../../php/api/form_builder/form_fields/" class="md-nav__link">
 639
 640
 641   <span class="md-ellipsis">
 642     Fields
 643   </span>
 644
 645
 646       </a>
 647     </li>
 648
 649
 650
 651
 652
 653
 654
 655
 656
 657     <li class="md-nav__item">
 658       <a href="../../../php/api/form_builder/validation_data/" class="md-nav__link">
 659
 660
 661   <span class="md-ellipsis">
 662     Validation and Data
 663   </span>
 664
 665
 666       </a>
 667     </li>
 668
 669
 670
 671
 672
 673
 674
 675
 676
 677     <li class="md-nav__item">
 678       <a href="../../../php/api/form_builder/dependencies/" class="md-nav__link">
 679
 680
 681   <span class="md-ellipsis">
 682     Dependencies
 683   </span>
 684
 685
 686       </a>
 687     </li>
 688
 689
 690
 691
 692           </ul>
 693         </nav>
 694
 695     </li>
 696
 697
 698
 699
 700
 701
 702
 703
 704
 705     <li class="md-nav__item">
 706       <a href="../../../php/api/package_installation_plugins/" class="md-nav__link">
 707
 708
 709   <span class="md-ellipsis">
 710     Package Installation Plugins
 711   </span>
 712
 713
 714       </a>
 715     </li>
 716
 717
 718
 719
 720
 721
 722
 723
 724
 725     <li class="md-nav__item">
 726       <a href="../../../php/api/user_activity_points/" class="md-nav__link">
 727
 728
 729   <span class="md-ellipsis">
 730     User Activity Points
 731   </span>
 732
 733
 734       </a>
 735     </li>
 736
 737
 738
 739
 740
 741
 742
 743
 744
 745     <li class="md-nav__item">
 746       <a href="../../../php/api/user_notifications/" class="md-nav__link">
 747
 748
 749   <span class="md-ellipsis">
 750     User Notifications
 751   </span>
 752
 753
 754       </a>
 755     </li>
 756
 757
 758
 759
 760
 761
 762
 763
 764
 765     <li class="md-nav__item">
 766       <a href="../../../php/api/sitemaps/" class="md-nav__link">
 767
 768
 769   <span class="md-ellipsis">
 770     Sitemaps
 771   </span>
 772
 773
 774       </a>
 775     </li>
 776
 777
 778
 779
 780           </ul>
 781         </nav>
 782
 783     </li>
 784
 785
 786
 787
 788
 789
 790
 791
 792
 793     <li class="md-nav__item">
 794       <a href="../../../php/code-style/" class="md-nav__link">
 795
 796
 797   <span class="md-ellipsis">
 798     Code Style
 799   </span>
 800
 801
 802       </a>
 803     </li>
 804
 805
 806
 807
 808
 809
 810
 811
 812
 813     <li class="md-nav__item">
 814       <a href="../../../php/apps/" class="md-nav__link">
 815
 816
 817   <span class="md-ellipsis">
 818     Apps
 819   </span>
 820
 821
 822       </a>
 823     </li>
 824
 825
 826
 827
 828
 829
 830
 831
 832
 833     <li class="md-nav__item">
 834       <a href="../../../php/gdpr/" class="md-nav__link">
 835
 836
 837   <span class="md-ellipsis">
 838     GDPR
 839   </span>
 840
 841
 842       </a>
 843     </li>
 844
 845
 846
 847
 848           </ul>
 849         </nav>
 850
 851     </li>
 852
 853
 854
 855
 856
 857
 858
 859
 860
 861
 862
 863     <li class="md-nav__item md-nav__item--nested">
 864
 865
 866
 867
 868
 869         <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_3" >
 870
 871           <label class="md-nav__link" for="__nav_3" id="__nav_3_label" tabindex="0">
 872
 873
 874   <span class="md-ellipsis">
 875     Languages, Templates & CSS
 876   </span>
 877
 878
 879             <span class="md-nav__icon md-icon"></span>
 880           </label>
 881
 882         <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_3_label" aria-expanded="false">
 883           <label class="md-nav__title" for="__nav_3">
 884             <span class="md-nav__icon md-icon"></span>
 885             Languages, Templates & CSS
 886           </label>
 887           <ul class="md-nav__list" data-md-scrollfix>
 888
 889
 890
 891
 892
 893
 894     <li class="md-nav__item">
 895       <a href="../../../view/languages/" class="md-nav__link">
 896
 897
 898   <span class="md-ellipsis">
 899     Languages
 900   </span>
 901
 902
 903       </a>
 904     </li>
 905
 906
 907
 908
 909
 910
 911
 912
 913
 914     <li class="md-nav__item">
 915       <a href="../../../view/templates/" class="md-nav__link">
 916
 917
 918   <span class="md-ellipsis">
 919     Templates
 920   </span>
 921
 922
 923       </a>
 924     </li>
 925
 926
 927
 928
 929
 930
 931
 932
 933
 934     <li class="md-nav__item">
 935       <a href="../../../view/template-modifiers/" class="md-nav__link">
 936
 937
 938   <span class="md-ellipsis">
 939     Template Modifiers
 940   </span>
 941
 942
 943       </a>
 944     </li>
 945
 946
 947
 948
 949
 950
 951
 952
 953
 954     <li class="md-nav__item">
 955       <a href="../../../view/template-plugins/" class="md-nav__link">
 956
 957
 958   <span class="md-ellipsis">
 959     Template Plugins
 960   </span>
 961
 962
 963       </a>
 964     </li>
 965
 966
 967
 968
 969
 970
 971
 972
 973
 974     <li class="md-nav__item">
 975       <a href="../../../view/css/" class="md-nav__link">
 976
 977
 978   <span class="md-ellipsis">
 979     CSS
 980   </span>
 981
 982
 983       </a>
 984     </li>
 985
 986
 987
 988
 989           </ul>
 990         </nav>
 991
 992     </li>
 993
 994
 995
 996
 997
 998
 999
1000
1001
1002
1003
1004     <li class="md-nav__item md-nav__item--nested">
1005
1006
1007
1008
1009
1010         <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4" >
1011
1012           <label class="md-nav__link" for="__nav_4" id="__nav_4_label" tabindex="0">
1013
1014
1015   <span class="md-ellipsis">
1016     TypeScript and JavaScript API
1017   </span>
1018
1019
1020             <span class="md-nav__icon md-icon"></span>
1021           </label>
1022
1023         <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="false">
1024           <label class="md-nav__title" for="__nav_4">
1025             <span class="md-nav__icon md-icon"></span>
1026             TypeScript and JavaScript API
1027           </label>
1028           <ul class="md-nav__list" data-md-scrollfix>
1029
1030
1031
1032
1033
1034
1035     <li class="md-nav__item">
1036       <a href="../../../javascript/general-usage/" class="md-nav__link">
1037
1038
1039   <span class="md-ellipsis">
1040     General Usage
1041   </span>
1042
1043
1044       </a>
1045     </li>
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055     <li class="md-nav__item">
1056       <a href="../../../javascript/typescript/" class="md-nav__link">
1057
1058
1059   <span class="md-ellipsis">
1060     TypeScript
1061   </span>
1062
1063
1064       </a>
1065     </li>
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078     <li class="md-nav__item md-nav__item--nested">
1079
1080
1081
1082
1083
1084         <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4_3" >
1085
1086           <label class="md-nav__link" for="__nav_4_3" id="__nav_4_3_label" tabindex="0">
1087
1088
1089   <span class="md-ellipsis">
1090     Components
1091   </span>
1092
1093
1094             <span class="md-nav__icon md-icon"></span>
1095           </label>
1096
1097         <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_4_3_label" aria-expanded="false">
1098           <label class="md-nav__title" for="__nav_4_3">
1099             <span class="md-nav__icon md-icon"></span>
1100             Components
1101           </label>
1102           <ul class="md-nav__list" data-md-scrollfix>
1103
1104
1105
1106
1107
1108
1109     <li class="md-nav__item">
1110       <a href="../../../javascript/components_ckeditor5/" class="md-nav__link">
1111
1112
1113   <span class="md-ellipsis">
1114     CKEditor 5
1115   </span>
1116
1117
1118       </a>
1119     </li>
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129     <li class="md-nav__item">
1130       <a href="../../../javascript/components_confirmation/" class="md-nav__link">
1131
1132
1133   <span class="md-ellipsis">
1134     Confirmation
1135   </span>
1136
1137
1138       </a>
1139     </li>
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149     <li class="md-nav__item">
1150       <a href="../../../javascript/components_dialog/" class="md-nav__link">
1151
1152
1153   <span class="md-ellipsis">
1154     Dialog
1155   </span>
1156
1157
1158       </a>
1159     </li>
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169     <li class="md-nav__item">
1170       <a href="../../../javascript/components_google_maps/" class="md-nav__link">
1171
1172
1173   <span class="md-ellipsis">
1174     Google Maps
1175   </span>
1176
1177
1178       </a>
1179     </li>
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189     <li class="md-nav__item">
1190       <a href="../../../javascript/components_pagination/" class="md-nav__link">
1191
1192
1193   <span class="md-ellipsis">
1194     Pagination
1195   </span>
1196
1197
1198       </a>
1199     </li>
1200
1201
1202
1203
1204           </ul>
1205         </nav>
1206
1207     </li>
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220     <li class="md-nav__item md-nav__item--nested">
1221
1222
1223
1224
1225
1226         <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4_4" >
1227
1228           <label class="md-nav__link" for="__nav_4_4" id="__nav_4_4_label" tabindex="0">
1229
1230
1231   <span class="md-ellipsis">
1232     New API
1233   </span>
1234
1235
1236             <span class="md-nav__icon md-icon"></span>
1237           </label>
1238
1239         <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_4_4_label" aria-expanded="false">
1240           <label class="md-nav__title" for="__nav_4_4">
1241             <span class="md-nav__icon md-icon"></span>
1242             New API
1243           </label>
1244           <ul class="md-nav__list" data-md-scrollfix>
1245
1246
1247
1248
1249
1250
1251     <li class="md-nav__item">
1252       <a href="../../../javascript/new-api_writing-a-module/" class="md-nav__link">
1253
1254
1255   <span class="md-ellipsis">
1256     Writing a module
1257   </span>
1258
1259
1260       </a>
1261     </li>
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271     <li class="md-nav__item">
1272       <a href="../../../javascript/new-api_core/" class="md-nav__link">
1273
1274
1275   <span class="md-ellipsis">
1276     Core Functions
1277   </span>
1278
1279
1280       </a>
1281     </li>
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291     <li class="md-nav__item">
1292       <a href="../../../javascript/new-api_dom/" class="md-nav__link">
1293
1294
1295   <span class="md-ellipsis">
1296     DOM
1297   </span>
1298
1299
1300       </a>
1301     </li>
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311     <li class="md-nav__item">
1312       <a href="../../../javascript/new-api_events/" class="md-nav__link">
1313
1314
1315   <span class="md-ellipsis">
1316     Event Handling
1317   </span>
1318
1319
1320       </a>
1321     </li>
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331     <li class="md-nav__item">
1332       <a href="../../../javascript/new-api_ajax/" class="md-nav__link">
1333
1334
1335   <span class="md-ellipsis">
1336     Ajax
1337   </span>
1338
1339
1340       </a>
1341     </li>
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351     <li class="md-nav__item">
1352       <a href="../../../javascript/new-api_dialogs/" class="md-nav__link">
1353
1354
1355   <span class="md-ellipsis">
1356     Dialogs
1357   </span>
1358
1359
1360       </a>
1361     </li>
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371     <li class="md-nav__item">
1372       <a href="../../../javascript/new-api_browser/" class="md-nav__link">
1373
1374
1375   <span class="md-ellipsis">
1376     Browser and Screen Sizes
1377   </span>
1378
1379
1380       </a>
1381     </li>
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391     <li class="md-nav__item">
1392       <a href="../../../javascript/new-api_ui/" class="md-nav__link">
1393
1394
1395   <span class="md-ellipsis">
1396     User Interface
1397   </span>
1398
1399
1400       </a>
1401     </li>
1402
1403
1404
1405
1406           </ul>
1407         </nav>
1408
1409     </li>
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419     <li class="md-nav__item">
1420       <a href="../../../javascript/legacy-api/" class="md-nav__link">
1421
1422
1423   <span class="md-ellipsis">
1424     Legacy API
1425   </span>
1426
1427
1428       </a>
1429     </li>
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439     <li class="md-nav__item">
1440       <a href="../../../javascript/code-snippets/" class="md-nav__link">
1441
1442
1443   <span class="md-ellipsis">
1444     Code Snippets
1445   </span>
1446
1447
1448       </a>
1449     </li>
1450
1451
1452
1453
1454           </ul>
1455         </nav>
1456
1457     </li>
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471     <li class="md-nav__item md-nav__item--active md-nav__item--nested">
1472
1473
1474
1475
1476
1477         <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_5" checked>
1478
1479           <label class="md-nav__link" for="__nav_5" id="__nav_5_label" tabindex="0">
1480
1481
1482   <span class="md-ellipsis">
1483     Package Components
1484   </span>
1485
1486
1487             <span class="md-nav__icon md-icon"></span>
1488           </label>
1489
1490         <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_5_label" aria-expanded="true">
1491           <label class="md-nav__title" for="__nav_5">
1492             <span class="md-nav__icon md-icon"></span>
1493             Package Components
1494           </label>
1495           <ul class="md-nav__list" data-md-scrollfix>
1496
1497
1498
1499
1500
1501
1502     <li class="md-nav__item">
1503       <a href="../../package-xml/" class="md-nav__link">
1504
1505
1506   <span class="md-ellipsis">
1507     package.xml
1508   </span>
1509
1510
1511       </a>
1512     </li>
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527     <li class="md-nav__item md-nav__item--active md-nav__item--nested">
1528
1529
1530
1531
1532
1533         <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_5_2" checked>
1534
1535           <label class="md-nav__link" for="__nav_5_2" id="__nav_5_2_label" tabindex="0">
1536
1537
1538   <span class="md-ellipsis">
1539     PIPs
1540   </span>
1541
1542
1543             <span class="md-nav__icon md-icon"></span>
1544           </label>
1545
1546         <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_5_2_label" aria-expanded="true">
1547           <label class="md-nav__title" for="__nav_5_2">
1548             <span class="md-nav__icon md-icon"></span>
1549             PIPs
1550           </label>
1551           <ul class="md-nav__list" data-md-scrollfix>
1552
1553
1554
1555
1556
1557
1558     <li class="md-nav__item">
1559       <a href="../" class="md-nav__link">
1560
1561
1562   <span class="md-ellipsis">
1563     Overview
1564   </span>
1565
1566
1567       </a>
1568     </li>
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578     <li class="md-nav__item">
1579       <a href="../acl-option/" class="md-nav__link">
1580
1581
1582   <span class="md-ellipsis">
1583     aclOption
1584   </span>
1585
1586
1587       </a>
1588     </li>
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598     <li class="md-nav__item">
1599       <a href="../acp-menu/" class="md-nav__link">
1600
1601
1602   <span class="md-ellipsis">
1603     acpMenu
1604   </span>
1605
1606
1607       </a>
1608     </li>
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618     <li class="md-nav__item">
1619       <a href="../acp-search-provider/" class="md-nav__link">
1620
1621
1622   <span class="md-ellipsis">
1623     acpSearchProvider
1624   </span>
1625
1626
1627       </a>
1628     </li>
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638     <li class="md-nav__item">
1639       <a href="../acp-template/" class="md-nav__link">
1640
1641
1642   <span class="md-ellipsis">
1643     acpTemplate
1644   </span>
1645
1646
1647       </a>
1648     </li>
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658     <li class="md-nav__item">
1659       <a href="../acp-template-delete/" class="md-nav__link">
1660
1661
1662   <span class="md-ellipsis">
1663     acpTemplateDelete
1664   </span>
1665
1666
1667       </a>
1668     </li>
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678     <li class="md-nav__item">
1679       <a href="../bbcode/" class="md-nav__link">
1680
1681
1682   <span class="md-ellipsis">
1683     bbcode
1684   </span>
1685
1686
1687       </a>
1688     </li>
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698     <li class="md-nav__item">
1699       <a href="../box/" class="md-nav__link">
1700
1701
1702   <span class="md-ellipsis">
1703     box
1704   </span>
1705
1706
1707       </a>
1708     </li>
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718     <li class="md-nav__item">
1719       <a href="../clipboard-action/" class="md-nav__link">
1720
1721
1722   <span class="md-ellipsis">
1723     clipboardAction
1724   </span>
1725
1726
1727       </a>
1728     </li>
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738     <li class="md-nav__item">
1739       <a href="../core-object/" class="md-nav__link">
1740
1741
1742   <span class="md-ellipsis">
1743     coreObject
1744   </span>
1745
1746
1747       </a>
1748     </li>
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758     <li class="md-nav__item">
1759       <a href="../cronjob/" class="md-nav__link">
1760
1761
1762   <span class="md-ellipsis">
1763     cronjob
1764   </span>
1765
1766
1767       </a>
1768     </li>
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778     <li class="md-nav__item">
1779       <a href="../database/" class="md-nav__link">
1780
1781
1782   <span class="md-ellipsis">
1783     database
1784   </span>
1785
1786
1787       </a>
1788     </li>
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798     <li class="md-nav__item">
1799       <a href="../event-listener/" class="md-nav__link">
1800
1801
1802   <span class="md-ellipsis">
1803     eventListener
1804   </span>
1805
1806
1807       </a>
1808     </li>
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818     <li class="md-nav__item">
1819       <a href="../file/" class="md-nav__link">
1820
1821
1822   <span class="md-ellipsis">
1823     file
1824   </span>
1825
1826
1827       </a>
1828     </li>
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838     <li class="md-nav__item">
1839       <a href="../file-delete/" class="md-nav__link">
1840
1841
1842   <span class="md-ellipsis">
1843     fileDelete
1844   </span>
1845
1846
1847       </a>
1848     </li>
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858     <li class="md-nav__item">
1859       <a href="../language/" class="md-nav__link">
1860
1861
1862   <span class="md-ellipsis">
1863     language
1864   </span>
1865
1866
1867       </a>
1868     </li>
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878     <li class="md-nav__item">
1879       <a href="../media-provider/" class="md-nav__link">
1880
1881
1882   <span class="md-ellipsis">
1883     mediaProvider
1884   </span>
1885
1886
1887       </a>
1888     </li>
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898     <li class="md-nav__item">
1899       <a href="../menu/" class="md-nav__link">
1900
1901
1902   <span class="md-ellipsis">
1903     menu
1904   </span>
1905
1906
1907       </a>
1908     </li>
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918     <li class="md-nav__item">
1919       <a href="../menu-item/" class="md-nav__link">
1920
1921
1922   <span class="md-ellipsis">
1923     menuItem
1924   </span>
1925
1926
1927       </a>
1928     </li>
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938     <li class="md-nav__item">
1939       <a href="../object-type/" class="md-nav__link">
1940
1941
1942   <span class="md-ellipsis">
1943     objectType
1944   </span>
1945
1946
1947       </a>
1948     </li>
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958     <li class="md-nav__item">
1959       <a href="../object-type-definition/" class="md-nav__link">
1960
1961
1962   <span class="md-ellipsis">
1963     objectTypeDefinition
1964   </span>
1965
1966
1967       </a>
1968     </li>
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978     <li class="md-nav__item">
1979       <a href="../option/" class="md-nav__link">
1980
1981
1982   <span class="md-ellipsis">
1983     option
1984   </span>
1985
1986
1987       </a>
1988     </li>
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998     <li class="md-nav__item">
1999       <a href="../page/" class="md-nav__link">
2000
2001
2002   <span class="md-ellipsis">
2003     page
2004   </span>
2005
2006
2007       </a>
2008     </li>
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018     <li class="md-nav__item">
2019       <a href="../pip/" class="md-nav__link">
2020
2021
2022   <span class="md-ellipsis">
2023     pip
2024   </span>
2025
2026
2027       </a>
2028     </li>
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038     <li class="md-nav__item">
2039       <a href="../script/" class="md-nav__link">
2040
2041
2042   <span class="md-ellipsis">
2043     script
2044   </span>
2045
2046
2047       </a>
2048     </li>
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058     <li class="md-nav__item">
2059       <a href="../smiley/" class="md-nav__link">
2060
2061
2062   <span class="md-ellipsis">
2063     smiley
2064   </span>
2065
2066
2067       </a>
2068     </li>
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078     <li class="md-nav__item">
2079       <a href="../sql/" class="md-nav__link">
2080
2081
2082   <span class="md-ellipsis">
2083     sql
2084   </span>
2085
2086
2087       </a>
2088     </li>
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098     <li class="md-nav__item">
2099       <a href="../style/" class="md-nav__link">
2100
2101
2102   <span class="md-ellipsis">
2103     style
2104   </span>
2105
2106
2107       </a>
2108     </li>
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118     <li class="md-nav__item">
2119       <a href="../template/" class="md-nav__link">
2120
2121
2122   <span class="md-ellipsis">
2123     template
2124   </span>
2125
2126
2127       </a>
2128     </li>
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138     <li class="md-nav__item">
2139       <a href="../template-delete/" class="md-nav__link">
2140
2141
2142   <span class="md-ellipsis">
2143     templateDelete
2144   </span>
2145
2146
2147       </a>
2148     </li>
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158     <li class="md-nav__item">
2159       <a href="../template-listener/" class="md-nav__link">
2160
2161
2162   <span class="md-ellipsis">
2163     templateListener
2164   </span>
2165
2166
2167       </a>
2168     </li>
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178     <li class="md-nav__item">
2179       <a href="../user-group-option/" class="md-nav__link">
2180
2181
2182   <span class="md-ellipsis">
2183     userGroupOption
2184   </span>
2185
2186
2187       </a>
2188     </li>
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198     <li class="md-nav__item">
2199       <a href="../user-menu/" class="md-nav__link">
2200
2201
2202   <span class="md-ellipsis">
2203     userMenu
2204   </span>
2205
2206
2207       </a>
2208     </li>
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220     <li class="md-nav__item md-nav__item--active">
2221
2222       <input class="md-nav__toggle md-toggle" type="checkbox" id="__toc">
2223
2224
2225
2226
2227
2228         <label class="md-nav__link md-nav__link--active" for="__toc">
2229
2230
2231   <span class="md-ellipsis">
2232     userNotificationEvent
2233   </span>
2234
2235
2236           <span class="md-nav__icon md-icon"></span>
2237         </label>
2238
2239       <a href="./" class="md-nav__link md-nav__link--active">
2240
2241
2242   <span class="md-ellipsis">
2243     userNotificationEvent
2244   </span>
2245
2246
2247       </a>
2248
2249
2250
2251 <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
2252
2253
2254
2255
2256
2257
2258     <label class="md-nav__title" for="__toc">
2259       <span class="md-nav__icon md-icon"></span>
2260       Table of contents
2261     </label>
2262     <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
2263
2264         <li class="md-nav__item">
2265   <a href="#components" class="md-nav__link">
2266     Components
2267   </a>
2268
2269     <nav class="md-nav" aria-label="Components">
2270       <ul class="md-nav__list">
2271
2272           <li class="md-nav__item">
2273   <a href="#objecttype" class="md-nav__link">
2274     &lt;objectType&gt;
2275   </a>
2276
2277 </li>
2278
2279           <li class="md-nav__item">
2280   <a href="#classname" class="md-nav__link">
2281     &lt;classname&gt;
2282   </a>
2283
2284 </li>
2285
2286           <li class="md-nav__item">
2287   <a href="#preset" class="md-nav__link">
2288     &lt;preset&gt;
2289   </a>
2290
2291 </li>
2292
2293           <li class="md-nav__item">
2294   <a href="#presetmailnotificationtype" class="md-nav__link">
2295     &lt;presetmailnotificationtype&gt;
2296   </a>
2297
2298 </li>
2299
2300           <li class="md-nav__item">
2301   <a href="#options" class="md-nav__link">
2302     &lt;options&gt;
2303   </a>
2304
2305 </li>
2306
2307           <li class="md-nav__item">
2308   <a href="#permissions" class="md-nav__link">
2309     &lt;permissions&gt;
2310   </a>
2311
2312 </li>
2313
2314       </ul>
2315     </nav>
2316
2317 </li>
2318
2319         <li class="md-nav__item">
2320   <a href="#example" class="md-nav__link">
2321     Example
2322   </a>
2323
2324 </li>
2325
2326     </ul>
2327
2328 </nav>
2329
2330     </li>
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340     <li class="md-nav__item">
2341       <a href="../user-option/" class="md-nav__link">
2342
2343
2344   <span class="md-ellipsis">
2345     userOption
2346   </span>
2347
2348
2349       </a>
2350     </li>
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360     <li class="md-nav__item">
2361       <a href="../user-profile-menu/" class="md-nav__link">
2362
2363
2364   <span class="md-ellipsis">
2365     userProfileMenu
2366   </span>
2367
2368
2369       </a>
2370     </li>
2371
2372
2373
2374
2375           </ul>
2376         </nav>
2377
2378     </li>
2379
2380
2381
2382
2383
2384
2385
2386
2387
2388     <li class="md-nav__item">
2389       <a href="../../database-php-api/" class="md-nav__link">
2390
2391
2392   <span class="md-ellipsis">
2393     Database PHP API
2394   </span>
2395
2396
2397       </a>
2398     </li>
2399
2400
2401
2402
2403           </ul>
2404         </nav>
2405
2406     </li>
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418     <li class="md-nav__item md-nav__item--nested">
2419
2420
2421
2422
2423
2424         <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_6" >
2425
2426           <label class="md-nav__link" for="__nav_6" id="__nav_6_label" tabindex="0">
2427
2428
2429   <span class="md-ellipsis">
2430     Migration
2431   </span>
2432
2433
2434             <span class="md-nav__icon md-icon"></span>
2435           </label>
2436
2437         <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_6_label" aria-expanded="false">
2438           <label class="md-nav__title" for="__nav_6">
2439             <span class="md-nav__icon md-icon"></span>
2440             Migration
2441           </label>
2442           <ul class="md-nav__list" data-md-scrollfix>
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452     <li class="md-nav__item md-nav__item--nested">
2453
2454
2455
2456
2457
2458         <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_6_1" >
2459
2460           <label class="md-nav__link" for="__nav_6_1" id="__nav_6_1_label" tabindex="0">
2461
2462
2463   <span class="md-ellipsis">
2464     From WoltLab Suite 5.5
2465   </span>
2466
2467
2468             <span class="md-nav__icon md-icon"></span>
2469           </label>
2470
2471         <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_1_label" aria-expanded="false">
2472           <label class="md-nav__title" for="__nav_6_1">
2473             <span class="md-nav__icon md-icon"></span>
2474             From WoltLab Suite 5.5
2475           </label>
2476           <ul class="md-nav__list" data-md-scrollfix>
2477
2478
2479
2480
2481
2482
2483     <li class="md-nav__item">
2484       <a href="../../../migration/wsc55/php/" class="md-nav__link">
2485
2486
2487   <span class="md-ellipsis">
2488     PHP API
2489   </span>
2490
2491
2492       </a>
2493     </li>
2494
2495
2496
2497
2498
2499
2500
2501
2502
2503     <li class="md-nav__item">
2504       <a href="../../../migration/wsc55/javascript/" class="md-nav__link">
2505
2506
2507   <span class="md-ellipsis">
2508     TypeScript and JavaScript
2509   </span>
2510
2511
2512       </a>
2513     </li>
2514
2515
2516
2517
2518
2519
2520
2521
2522
2523     <li class="md-nav__item">
2524       <a href="../../../migration/wsc55/templates/" class="md-nav__link">
2525
2526
2527   <span class="md-ellipsis">
2528     Templates
2529   </span>
2530
2531
2532       </a>
2533     </li>
2534
2535
2536
2537
2538
2539
2540
2541
2542
2543     <li class="md-nav__item">
2544       <a href="../../../migration/wsc55/icons/" class="md-nav__link">
2545
2546
2547   <span class="md-ellipsis">
2548     Icons
2549   </span>
2550
2551
2552       </a>
2553     </li>
2554
2555
2556
2557
2558
2559
2560
2561
2562
2563     <li class="md-nav__item">
2564       <a href="../../../migration/wsc55/dialogs/" class="md-nav__link">
2565
2566
2567   <span class="md-ellipsis">
2568     Dialogs
2569   </span>
2570
2571
2572       </a>
2573     </li>
2574
2575
2576
2577
2578
2579
2580
2581
2582
2583     <li class="md-nav__item">
2584       <a href="../../../migration/wsc55/libraries/" class="md-nav__link">
2585
2586
2587   <span class="md-ellipsis">
2588     Third Party Libraries
2589   </span>
2590
2591
2592       </a>
2593     </li>
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603     <li class="md-nav__item">
2604       <a href="../../../migration/wsc55/deprecations_removals/" class="md-nav__link">
2605
2606
2607   <span class="md-ellipsis">
2608     Deprecations and Removals
2609   </span>
2610
2611
2612       </a>
2613     </li>
2614
2615
2616
2617
2618           </ul>
2619         </nav>
2620
2621     </li>
2622
2623
2624
2625
2626
2627
2628
2629
2630
2631
2632
2633
2634     <li class="md-nav__item md-nav__item--nested">
2635
2636
2637
2638
2639
2640         <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_6_2" >
2641
2642           <label class="md-nav__link" for="__nav_6_2" id="__nav_6_2_label" tabindex="0">
2643
2644
2645   <span class="md-ellipsis">
2646     From WoltLab Suite 5.4
2647   </span>
2648
2649
2650             <span class="md-nav__icon md-icon"></span>
2651           </label>
2652
2653         <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_2_label" aria-expanded="false">
2654           <label class="md-nav__title" for="__nav_6_2">
2655             <span class="md-nav__icon md-icon"></span>
2656             From WoltLab Suite 5.4
2657           </label>
2658           <ul class="md-nav__list" data-md-scrollfix>
2659
2660
2661
2662
2663
2664
2665     <li class="md-nav__item">
2666       <a href="../../../migration/wsc54/php/" class="md-nav__link">
2667
2668
2669   <span class="md-ellipsis">
2670     PHP API
2671   </span>
2672
2673
2674       </a>
2675     </li>
2676
2677
2678
2679
2680
2681
2682
2683
2684
2685     <li class="md-nav__item">
2686       <a href="../../../migration/wsc54/javascript/" class="md-nav__link">
2687
2688
2689   <span class="md-ellipsis">
2690     TypeScript and JavaScript
2691   </span>
2692
2693
2694       </a>
2695     </li>
2696
2697
2698
2699
2700
2701
2702
2703
2704
2705     <li class="md-nav__item">
2706       <a href="../../../migration/wsc54/templates/" class="md-nav__link">
2707
2708
2709   <span class="md-ellipsis">
2710     Templates
2711   </span>
2712
2713
2714       </a>
2715     </li>
2716
2717
2718
2719
2720
2721
2722
2723
2724
2725     <li class="md-nav__item">
2726       <a href="../../../migration/wsc54/libraries/" class="md-nav__link">
2727
2728
2729   <span class="md-ellipsis">
2730     Third Party Libraries
2731   </span>
2732
2733
2734       </a>
2735     </li>
2736
2737
2738
2739
2740
2741
2742
2743
2744
2745     <li class="md-nav__item">
2746       <a href="../../../migration/wsc54/deprecations_removals/" class="md-nav__link">
2747
2748
2749   <span class="md-ellipsis">
2750     Deprecations and Removals
2751   </span>
2752
2753
2754       </a>
2755     </li>
2756
2757
2758
2759
2760           </ul>
2761         </nav>
2762
2763     </li>
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776     <li class="md-nav__item md-nav__item--nested">
2777
2778
2779
2780
2781
2782         <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_6_3" >
2783
2784           <label class="md-nav__link" for="__nav_6_3" id="__nav_6_3_label" tabindex="0">
2785
2786
2787   <span class="md-ellipsis">
2788     From WoltLab Suite 5.3
2789   </span>
2790
2791
2792             <span class="md-nav__icon md-icon"></span>
2793           </label>
2794
2795         <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_3_label" aria-expanded="false">
2796           <label class="md-nav__title" for="__nav_6_3">
2797             <span class="md-nav__icon md-icon"></span>
2798             From WoltLab Suite 5.3
2799           </label>
2800           <ul class="md-nav__list" data-md-scrollfix>
2801
2802
2803
2804
2805
2806
2807     <li class="md-nav__item">
2808       <a href="../../../migration/wsc53/php/" class="md-nav__link">
2809
2810
2811   <span class="md-ellipsis">
2812     PHP API
2813   </span>
2814
2815
2816       </a>
2817     </li>
2818
2819
2820
2821
2822
2823
2824
2825
2826
2827     <li class="md-nav__item">
2828       <a href="../../../migration/wsc53/session/" class="md-nav__link">
2829
2830
2831   <span class="md-ellipsis">
2832     Session Handling and Authentication
2833   </span>
2834
2835
2836       </a>
2837     </li>
2838
2839
2840
2841
2842
2843
2844
2845
2846
2847     <li class="md-nav__item">
2848       <a href="../../../migration/wsc53/javascript/" class="md-nav__link">
2849
2850
2851   <span class="md-ellipsis">
2852     TypeScript and JavaScript
2853   </span>
2854
2855
2856       </a>
2857     </li>
2858
2859
2860
2861
2862
2863
2864
2865
2866
2867     <li class="md-nav__item">
2868       <a href="../../../migration/wsc53/templates/" class="md-nav__link">
2869
2870
2871   <span class="md-ellipsis">
2872     Templates
2873   </span>
2874
2875
2876       </a>
2877     </li>
2878
2879
2880
2881
2882
2883
2884
2885
2886
2887     <li class="md-nav__item">
2888       <a href="../../../migration/wsc53/libraries/" class="md-nav__link">
2889
2890
2891   <span class="md-ellipsis">
2892     Third Party Libraries
2893   </span>
2894
2895
2896       </a>
2897     </li>
2898
2899
2900
2901
2902           </ul>
2903         </nav>
2904
2905     </li>
2906
2907
2908
2909
2910
2911
2912
2913
2914
2915
2916
2917
2918     <li class="md-nav__item md-nav__item--nested">
2919
2920
2921
2922
2923
2924         <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_6_4" >
2925
2926           <label class="md-nav__link" for="__nav_6_4" id="__nav_6_4_label" tabindex="0">
2927
2928
2929   <span class="md-ellipsis">
2930     From WoltLab Suite 5.2
2931   </span>
2932
2933
2934             <span class="md-nav__icon md-icon"></span>
2935           </label>
2936
2937         <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_4_label" aria-expanded="false">
2938           <label class="md-nav__title" for="__nav_6_4">
2939             <span class="md-nav__icon md-icon"></span>
2940             From WoltLab Suite 5.2
2941           </label>
2942           <ul class="md-nav__list" data-md-scrollfix>
2943
2944
2945
2946
2947
2948
2949     <li class="md-nav__item">
2950       <a href="../../../migration/wsc52/php/" class="md-nav__link">
2951
2952
2953   <span class="md-ellipsis">
2954     PHP API
2955   </span>
2956
2957
2958       </a>
2959     </li>
2960
2961
2962
2963
2964
2965
2966
2967
2968
2969     <li class="md-nav__item">
2970       <a href="../../../migration/wsc52/templates/" class="md-nav__link">
2971
2972
2973   <span class="md-ellipsis">
2974     Templates and Languages
2975   </span>
2976
2977
2978       </a>
2979     </li>
2980
2981
2982
2983
2984
2985
2986
2987
2988
2989     <li class="md-nav__item">
2990       <a href="../../../migration/wsc52/libraries/" class="md-nav__link">
2991
2992
2993   <span class="md-ellipsis">
2994     Third Party Libraries
2995   </span>
2996
2997
2998       </a>
2999     </li>
3000
3001
3002
3003
3004           </ul>
3005         </nav>
3006
3007     </li>
3008
3009
3010
3011
3012
3013
3014
3015
3016
3017
3018
3019
3020     <li class="md-nav__item md-nav__item--nested">
3021
3022
3023
3024
3025
3026         <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_6_5" >
3027
3028           <label class="md-nav__link" for="__nav_6_5" id="__nav_6_5_label" tabindex="0">
3029
3030
3031   <span class="md-ellipsis">
3032     From WoltLab Suite 3.1
3033   </span>
3034
3035
3036             <span class="md-nav__icon md-icon"></span>
3037           </label>
3038
3039         <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_5_label" aria-expanded="false">
3040           <label class="md-nav__title" for="__nav_6_5">
3041             <span class="md-nav__icon md-icon"></span>
3042             From WoltLab Suite 3.1
3043           </label>
3044           <ul class="md-nav__list" data-md-scrollfix>
3045
3046
3047
3048
3049
3050
3051     <li class="md-nav__item">
3052       <a href="../../../migration/wsc31/php/" class="md-nav__link">
3053
3054
3055   <span class="md-ellipsis">
3056     PHP API
3057   </span>
3058
3059
3060       </a>
3061     </li>
3062
3063
3064
3065
3066           </ul>
3067         </nav>
3068
3069     </li>
3070
3071
3072
3073
3074
3075
3076
3077
3078
3079
3080
3081
3082     <li class="md-nav__item md-nav__item--nested">
3083
3084
3085
3086
3087
3088         <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_6_6" >
3089
3090           <label class="md-nav__link" for="__nav_6_6" id="__nav_6_6_label" tabindex="0">
3091
3092
3093   <span class="md-ellipsis">
3094     From WoltLab Suite 3.0
3095   </span>
3096
3097
3098             <span class="md-nav__icon md-icon"></span>
3099           </label>
3100
3101         <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_6_label" aria-expanded="false">
3102           <label class="md-nav__title" for="__nav_6_6">
3103             <span class="md-nav__icon md-icon"></span>
3104             From WoltLab Suite 3.0
3105           </label>
3106           <ul class="md-nav__list" data-md-scrollfix>
3107
3108
3109
3110
3111
3112
3113     <li class="md-nav__item">
3114       <a href="../../../migration/wsc30/php/" class="md-nav__link">
3115
3116
3117   <span class="md-ellipsis">
3118     PHP API
3119   </span>
3120
3121
3122       </a>
3123     </li>
3124
3125
3126
3127
3128
3129
3130
3131
3132
3133     <li class="md-nav__item">
3134       <a href="../../../migration/wsc30/javascript/" class="md-nav__link">
3135
3136
3137   <span class="md-ellipsis">
3138     JavaScript API
3139   </span>
3140
3141
3142       </a>
3143     </li>
3144
3145
3146
3147
3148
3149
3150
3151
3152
3153     <li class="md-nav__item">
3154       <a href="../../../migration/wsc30/templates/" class="md-nav__link">
3155
3156
3157   <span class="md-ellipsis">
3158     Templates
3159   </span>
3160
3161
3162       </a>
3163     </li>
3164
3165
3166
3167
3168
3169
3170
3171
3172
3173     <li class="md-nav__item">
3174       <a href="../../../migration/wsc30/css/" class="md-nav__link">
3175
3176
3177   <span class="md-ellipsis">
3178     CSS
3179   </span>
3180
3181
3182       </a>
3183     </li>
3184
3185
3186
3187
3188
3189
3190
3191
3192
3193     <li class="md-nav__item">
3194       <a href="../../../migration/wsc30/package/" class="md-nav__link">
3195
3196
3197   <span class="md-ellipsis">
3198     Package Components
3199   </span>
3200
3201
3202       </a>
3203     </li>
3204
3205
3206
3207
3208           </ul>
3209         </nav>
3210
3211     </li>
3212
3213
3214
3215
3216
3217
3218
3219
3220
3221
3222
3223
3224     <li class="md-nav__item md-nav__item--nested">
3225
3226
3227
3228
3229
3230         <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_6_7" >
3231
3232           <label class="md-nav__link" for="__nav_6_7" id="__nav_6_7_label" tabindex="0">
3233
3234
3235   <span class="md-ellipsis">
3236     From WCF 2.1
3237   </span>
3238
3239
3240             <span class="md-nav__icon md-icon"></span>
3241           </label>
3242
3243         <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_7_label" aria-expanded="false">
3244           <label class="md-nav__title" for="__nav_6_7">
3245             <span class="md-nav__icon md-icon"></span>
3246             From WCF 2.1
3247           </label>
3248           <ul class="md-nav__list" data-md-scrollfix>
3249
3250
3251
3252
3253
3254
3255     <li class="md-nav__item">
3256       <a href="../../../migration/wcf21/php/" class="md-nav__link">
3257
3258
3259   <span class="md-ellipsis">
3260     PHP API
3261   </span>
3262
3263
3264       </a>
3265     </li>
3266
3267
3268
3269
3270
3271
3272
3273
3274
3275     <li class="md-nav__item">
3276       <a href="../../../migration/wcf21/templates/" class="md-nav__link">
3277
3278
3279   <span class="md-ellipsis">
3280     Templates
3281   </span>
3282
3283
3284       </a>
3285     </li>
3286
3287
3288
3289
3290
3291
3292
3293
3294
3295     <li class="md-nav__item">
3296       <a href="../../../migration/wcf21/css/" class="md-nav__link">
3297
3298
3299   <span class="md-ellipsis">
3300     CSS
3301   </span>
3302
3303
3304       </a>
3305     </li>
3306
3307
3308
3309
3310
3311
3312
3313
3314
3315     <li class="md-nav__item">
3316       <a href="../../../migration/wcf21/package/" class="md-nav__link">
3317
3318
3319   <span class="md-ellipsis">
3320     Package Components
3321   </span>
3322
3323
3324       </a>
3325     </li>
3326
3327
3328
3329
3330           </ul>
3331         </nav>
3332
3333     </li>
3334
3335
3336
3337
3338           </ul>
3339         </nav>
3340
3341     </li>
3342
3343
3344
3345
3346
3347
3348
3349
3350
3351
3352
3353     <li class="md-nav__item md-nav__item--nested">
3354
3355
3356
3357
3358
3359         <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_7" >
3360
3361           <label class="md-nav__link" for="__nav_7" id="__nav_7_label" tabindex="0">
3362
3363
3364   <span class="md-ellipsis">
3365     Tutorials
3366   </span>
3367
3368
3369             <span class="md-nav__icon md-icon"></span>
3370           </label>
3371
3372         <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_7_label" aria-expanded="false">
3373           <label class="md-nav__title" for="__nav_7">
3374             <span class="md-nav__icon md-icon"></span>
3375             Tutorials
3376           </label>
3377           <ul class="md-nav__list" data-md-scrollfix>
3378
3379
3380
3381
3382
3383
3384
3385
3386
3387     <li class="md-nav__item md-nav__item--nested">
3388
3389
3390
3391
3392
3393         <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_7_1" >
3394
3395           <label class="md-nav__link" for="__nav_7_1" id="__nav_7_1_label" tabindex="0">
3396
3397
3398   <span class="md-ellipsis">
3399     Tutorial Series
3400   </span>
3401
3402
3403             <span class="md-nav__icon md-icon"></span>
3404           </label>
3405
3406         <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_7_1_label" aria-expanded="false">
3407           <label class="md-nav__title" for="__nav_7_1">
3408             <span class="md-nav__icon md-icon"></span>
3409             Tutorial Series
3410           </label>
3411           <ul class="md-nav__list" data-md-scrollfix>
3412
3413
3414
3415
3416
3417
3418     <li class="md-nav__item">
3419       <a href="../../../tutorial/series/overview/" class="md-nav__link">
3420
3421
3422   <span class="md-ellipsis">
3423     Overview
3424   </span>
3425
3426
3427       </a>
3428     </li>
3429
3430
3431
3432
3433
3434
3435
3436
3437
3438     <li class="md-nav__item">
3439       <a href="../../../tutorial/series/part_1/" class="md-nav__link">
3440
3441
3442   <span class="md-ellipsis">
3443     Part 1
3444   </span>
3445
3446
3447       </a>
3448     </li>
3449
3450
3451
3452
3453
3454
3455
3456
3457
3458     <li class="md-nav__item">
3459       <a href="../../../tutorial/series/part_2/" class="md-nav__link">
3460
3461
3462   <span class="md-ellipsis">
3463     Part 2
3464   </span>
3465
3466
3467       </a>
3468     </li>
3469
3470
3471
3472
3473
3474
3475
3476
3477
3478     <li class="md-nav__item">
3479       <a href="../../../tutorial/series/part_3/" class="md-nav__link">
3480
3481
3482   <span class="md-ellipsis">
3483     Part 3
3484   </span>
3485
3486
3487       </a>
3488     </li>
3489
3490
3491
3492
3493
3494
3495
3496
3497
3498     <li class="md-nav__item">
3499       <a href="../../../tutorial/series/part_4/" class="md-nav__link">
3500
3501
3502   <span class="md-ellipsis">
3503     Part 4
3504   </span>
3505
3506
3507       </a>
3508     </li>
3509
3510
3511
3512
3513
3514
3515
3516
3517
3518     <li class="md-nav__item">
3519       <a href="../../../tutorial/series/part_5/" class="md-nav__link">
3520
3521
3522   <span class="md-ellipsis">
3523     Part 5
3524   </span>
3525
3526
3527       </a>
3528     </li>
3529
3530
3531
3532
3533
3534
3535
3536
3537
3538     <li class="md-nav__item">
3539       <a href="../../../tutorial/series/part_6/" class="md-nav__link">
3540
3541
3542   <span class="md-ellipsis">
3543     Part 6
3544   </span>
3545
3546
3547       </a>
3548     </li>
3549
3550
3551
3552
3553           </ul>
3554         </nav>
3555
3556     </li>
3557
3558
3559
3560
3561           </ul>
3562         </nav>
3563
3564     </li>
3565
3566
3567
3568   </ul>
3569 </nav>
3570                   </div>
3571                 </div>
3572               </div>
3573
3574
3575
3576               <div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
3577                 <div class="md-sidebar__scrollwrap">
3578                   <div class="md-sidebar__inner">
3579
3580
3581 <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
3582
3583
3584
3585
3586
3587
3588     <label class="md-nav__title" for="__toc">
3589       <span class="md-nav__icon md-icon"></span>
3590       Table of contents
3591     </label>
3592     <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
3593
3594         <li class="md-nav__item">
3595   <a href="#components" class="md-nav__link">
3596     Components
3597   </a>
3598
3599     <nav class="md-nav" aria-label="Components">
3600       <ul class="md-nav__list">
3601
3602           <li class="md-nav__item">
3603   <a href="#objecttype" class="md-nav__link">
3604     &lt;objectType&gt;
3605   </a>
3606
3607 </li>
3608
3609           <li class="md-nav__item">
3610   <a href="#classname" class="md-nav__link">
3611     &lt;classname&gt;
3612   </a>
3613
3614 </li>
3615
3616           <li class="md-nav__item">
3617   <a href="#preset" class="md-nav__link">
3618     &lt;preset&gt;
3619   </a>
3620
3621 </li>
3622
3623           <li class="md-nav__item">
3624   <a href="#presetmailnotificationtype" class="md-nav__link">
3625     &lt;presetmailnotificationtype&gt;
3626   </a>
3627
3628 </li>
3629
3630           <li class="md-nav__item">
3631   <a href="#options" class="md-nav__link">
3632     &lt;options&gt;
3633   </a>
3634
3635 </li>
3636
3637           <li class="md-nav__item">
3638   <a href="#permissions" class="md-nav__link">
3639     &lt;permissions&gt;
3640   </a>
3641
3642 </li>
3643
3644       </ul>
3645     </nav>
3646
3647 </li>
3648
3649         <li class="md-nav__item">
3650   <a href="#example" class="md-nav__link">
3651     Example
3652   </a>
3653
3654 </li>
3655
3656     </ul>
3657
3658 </nav>
3659                   </div>
3660                 </div>
3661               </div>
3662
3663
3664
3665             <div class="md-content" data-md-component="content">
3666               <article class="md-content__inner md-typeset">
3667
3668
3669
3670
3671
3672
3673
3674 <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>
3675 <p>Registers new user notification events.</p>
3676 <h2 id="components">Components<a class="headerlink" href="#components" title="Permanent link">#</a></h2>
3677 <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>
3678 <h3 id="objecttype"><code>&lt;objectType&gt;</code><a class="headerlink" href="#objecttype" title="Permanent link">#</a></h3>
3679 <div class="admonition warning">
3680 <p class="admonition-title">The <code>(name, objectType)</code> pair must be unique.</p>
3681 </div>
3682 <p>The given object type must implement the <code>com.woltlab.wcf.notification.objectType</code> definition.</p>
3683 <h3 id="classname"><code>&lt;classname&gt;</code><a class="headerlink" href="#classname" title="Permanent link">#</a></h3>
3684 <p>The name of the class providing the event's behaviour,
3685 the class has to implement the <code>wcf\system\user\notification\event\IUserNotificationEvent</code> interface.</p>
3686 <h3 id="preset"><code>&lt;preset&gt;</code><a class="headerlink" href="#preset" title="Permanent link">#</a></h3>
3687 <p>Defines whether this event is enabled by default.</p>
3688 <h3 id="presetmailnotificationtype"><code>&lt;presetmailnotificationtype&gt;</code><a class="headerlink" href="#presetmailnotificationtype" title="Permanent link">#</a></h3>
3689 <div class="admonition info">
3690 <p class="admonition-title">Avoid using this option, as sending unsolicited mail can be seen as spamming.</p>
3691 </div>
3692 <p>One of <code>instant</code> or <code>daily</code>.
3693 Defines whether this type of email notifications is enabled by default.</p>
3694 <h3 id="options"><code>&lt;options&gt;</code><a class="headerlink" href="#options" title="Permanent link">#</a></h3>
3695 <p><span class="label label-info">Optional</span></p>
3696 <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>
3697 <h3 id="permissions"><code>&lt;permissions&gt;</code><a class="headerlink" href="#permissions" title="Permanent link">#</a></h3>
3698 <p><span class="label label-info">Optional</span></p>
3699 <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>
3700 <h2 id="example">Example<a class="headerlink" href="#example" title="Permanent link">#</a></h2>
3701 <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.1/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>
3702 <span class="normal"> 2</span>
3703 <span class="normal"> 3</span>
3704 <span class="normal"> 4</span>
3705 <span class="normal"> 5</span>
3706 <span class="normal"> 6</span>
3707 <span class="normal"> 7</span>
3708 <span class="normal"> 8</span>
3709 <span class="normal"> 9</span>
3710 <span class="normal">10</span>
3711 <span class="normal">11</span>
3712 <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>
3713 <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>
3714 <span class="w">    </span><span class="nt">&lt;import&gt;</span>
3715 <span class="w">        </span><span class="nt">&lt;event&gt;</span>
3716 <span class="w">            </span><span class="nt">&lt;name&gt;</span>like<span class="nt">&lt;/name&gt;</span>
3717 <span class="w">            </span><span class="nt">&lt;objecttype&gt;</span>com.woltlab.example.comment.like.notification<span class="nt">&lt;/objecttype&gt;</span>
3718 <span class="w">            </span><span class="nt">&lt;classname&gt;</span>wcf\system\user\notification\event\ExampleCommentLikeUserNotificationEvent<span class="nt">&lt;/classname&gt;</span>
3719 <span class="w">            </span><span class="nt">&lt;preset&gt;</span>1<span class="nt">&lt;/preset&gt;</span>
3720 <span class="w">            </span><span class="nt">&lt;options&gt;</span>module_like<span class="nt">&lt;/options&gt;</span>
3721 <span class="w">        </span><span class="nt">&lt;/event&gt;</span>
3722 <span class="w">    </span><span class="nt">&lt;/import&gt;</span>
3723 <span class="nt">&lt;/data&gt;</span>
3724 </code></pre></div></td></tr></table></div>
3725
3726   <hr>
3727 <div class="md-source-file">
3728   <small>
3729
3730       Last update:
3731       2021-04-23
3732
3733   </small>
3734 </div>
3735
3736
3737
3738
3739
3740
3741               </article>
3742             </div>
3743
3744
3745         </div>
3746
3747       </main>
3748
3749         <footer class="md-footer">
3750
3751   <div class="md-footer-meta md-typeset">
3752     <div class="md-footer-meta__inner md-grid">
3753       <div class="md-copyright">
3754
3755     <div class="md-copyright__highlight">
3756       Copyright © 2020 WoltLab GmbH
3757     </div>
3758
3759
3760     Made with
3761     <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
3762       Material for MkDocs
3763     </a>
3764
3765 </div>
3766
3767         <div class="md-copyright">
3768         <a href="https://www.woltlab.com/legal-notice/">Legal Notice</a>
3769         <a href="https://www.woltlab.com/privacy-policy/">Privacy Policy</a>
3770 </div>
3771
3772     </div>
3773   </div>
3774 </footer>
3775
3776     </div>
3777     <div class="md-dialog" data-md-component="dialog">
3778       <div class="md-dialog__inner md-typeset"></div>
3779     </div>
3780
3781     <script id="__config" type="application/json">{"base": "../../..", "features": ["navigation.tracking"], "search": "../../../assets/javascripts/workers/search.dfff1995.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>
3782
3783
3784       <script src="../../../assets/javascripts/bundle.dff1b7c8.min.js"></script>
3785
3786
3787   </body>
3788 </html>