5.4/javascript/new-api_ajax/index.html

   1
   2 <!doctype html>
   3 <html lang="en" class="no-js">
   4   <head>
   5
   6       <meta charset="utf-8">
   7       <meta name="viewport" content="width=device-width,initial-scale=1">
   8
   9
  10
  11
  12       <link rel="icon" href="../../assets/default.favicon.ico">
  13       <meta name="generator" content="mkdocs-1.1.2, mkdocs-material-7.1.2">
  14
  15
  16
  17         <title>Ajax - WoltLab Suite Documentation</title>
  18
  19
  20
  21       <link rel="stylesheet" href="../../assets/stylesheets/main.6f955dcd.min.css">
  22
  23
  24         <link rel="stylesheet" href="../../assets/stylesheets/palette.ef6f36e2.min.css">
  25
  26
  27
  28           <meta name="theme-color" content="#009485">
  29
  30
  31
  32
  33
  34
  35
  36
  37
  38       <link rel="stylesheet" href="../../stylesheets/extra.css">
  39
  40
  41
  42
  43
  44   </head>
  45
  46
  47
  48
  49
  50
  51
  52     <body dir="ltr" data-md-color-scheme="" data-md-color-primary="teal" data-md-color-accent="">
  53
  54
  55     <script>function __prefix(e){return new URL("../..",location).pathname+"."+e}function __get(e,t=localStorage){return JSON.parse(t.getItem(__prefix(e)))}</script>
  56
  57     <input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
  58     <input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
  59     <label class="md-overlay" for="__drawer"></label>
  60     <div data-md-component="skip">
  61
  62
  63         <a href="#ajax-requests-javascript-api" class="md-skip">
  64           Skip to content
  65         </a>
  66
  67     </div>
  68     <div data-md-component="announce">
  69
  70         <aside class="md-announce">
  71           <div class="md-announce__inner md-grid md-typeset">
  72
  73     <a href="https://www.woltlab.com">Back to <strong>woltlab.com</strong></a>
  74
  75           </div>
  76         </aside>
  77
  78     </div>
  79
  80       <header class="md-header" data-md-component="header">
  81   <nav class="md-header__inner md-grid" aria-label="Header">
  82     <a href="../.." title="WoltLab Suite Documentation" class="md-header__button md-logo" aria-label="WoltLab Suite Documentation" data-md-component="logo">
  83
  84   <img src="../../assets/logo.png" alt="logo">
  85
  86     </a>
  87     <label class="md-header__button md-icon" for="__drawer">
  88       <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3 6h18v2H3V6m0 5h18v2H3v-2m0 5h18v2H3v-2z"/></svg>
  89     </label>
  90     <div class="md-header__title" data-md-component="header-title">
  91       <div class="md-header__ellipsis">
  92         <div class="md-header__topic">
  93           <span class="md-ellipsis">
  94             WoltLab Suite Documentation
  95           </span>
  96         </div>
  97         <div class="md-header__topic" data-md-component="header-topic">
  98           <span class="md-ellipsis">
  99
 100               Ajax
 101
 102           </span>
 103         </div>
 104       </div>
 105     </div>
 106
 107
 108
 109       <label class="md-header__button md-icon" for="__search">
 110         <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.516 6.516 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5z"/></svg>
 111       </label>
 112
 113 <div class="md-search" data-md-component="search" role="dialog">
 114   <label class="md-search__overlay" for="__search"></label>
 115   <div class="md-search__inner" role="search">
 116     <form class="md-search__form" name="search">
 117       <input type="text" class="md-search__input" name="query" aria-label="Search" placeholder="Search" autocapitalize="off" autocorrect="off" autocomplete="off" spellcheck="false" data-md-component="search-query" data-md-state="active" required>
 118       <label class="md-search__icon md-icon" for="__search">
 119         <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.516 6.516 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5z"/></svg>
 120         <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11h12z"/></svg>
 121       </label>
 122       <button type="reset" class="md-search__icon md-icon" aria-label="Clear" tabindex="-1">
 123         <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M19 6.41 17.59 5 12 10.59 6.41 5 5 6.41 10.59 12 5 17.59 6.41 19 12 13.41 17.59 19 19 17.59 13.41 12 19 6.41z"/></svg>
 124       </button>
 125     </form>
 126     <div class="md-search__output">
 127       <div class="md-search__scrollwrap" data-md-scrollfix>
 128         <div class="md-search-result" data-md-component="search-result">
 129           <div class="md-search-result__meta">
 130             Initializing search
 131           </div>
 132           <ol class="md-search-result__list"></ol>
 133         </div>
 134       </div>
 135     </div>
 136   </div>
 137 </div>
 138
 139
 140       <div class="md-header__source">
 141
 142 <a href="https://github.com/WoltLab/docs.woltlab.com/" title="Go to repository" class="md-source" data-md-component="source">
 143   <div class="md-source__icon md-icon">
 144
 145     <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><path d="M439.55 236.05 244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25.3 12.54 22.26 41.85 9.08 55a34.34 34.34 0 0 1-48.55 0c-17.57-17.6-11.07-46.91 11.25-56v-123c-20.8-8.51-24.6-30.74-18.64-45L142.57 101 8.45 235.14a28.86 28.86 0 0 0 0 40.81l195.61 195.6a28.86 28.86 0 0 0 40.8 0l194.69-194.69a28.86 28.86 0 0 0 0-40.81z"/></svg>
 146   </div>
 147   <div class="md-source__repository">
 148     GitHub
 149   </div>
 150 </a>
 151       </div>
 152
 153   </nav>
 154 </header>
 155
 156     <div class="md-container" data-md-component="container">
 157
 158
 159
 160
 161       <main class="md-main" data-md-component="main">
 162         <div class="md-main__inner md-grid">
 163
 164
 165
 166               <div class="md-sidebar md-sidebar--primary" data-md-component="sidebar" data-md-type="navigation" >
 167                 <div class="md-sidebar__scrollwrap">
 168                   <div class="md-sidebar__inner">
 169
 170
 171
 172 <nav class="md-nav md-nav--primary" aria-label="Navigation" data-md-level="0">
 173   <label class="md-nav__title" for="__drawer">
 174     <a href="../.." title="WoltLab Suite Documentation" class="md-nav__button md-logo" aria-label="WoltLab Suite Documentation" data-md-component="logo">
 175
 176   <img src="../../assets/logo.png" alt="logo">
 177
 178     </a>
 179     WoltLab Suite Documentation
 180   </label>
 181
 182     <div class="md-nav__source">
 183
 184 <a href="https://github.com/WoltLab/docs.woltlab.com/" title="Go to repository" class="md-source" data-md-component="source">
 185   <div class="md-source__icon md-icon">
 186
 187     <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><path d="M439.55 236.05 244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25.3 12.54 22.26 41.85 9.08 55a34.34 34.34 0 0 1-48.55 0c-17.57-17.6-11.07-46.91 11.25-56v-123c-20.8-8.51-24.6-30.74-18.64-45L142.57 101 8.45 235.14a28.86 28.86 0 0 0 0 40.81l195.61 195.6a28.86 28.86 0 0 0 40.8 0l194.69-194.69a28.86 28.86 0 0 0 0-40.81z"/></svg>
 188   </div>
 189   <div class="md-source__repository">
 190     GitHub
 191   </div>
 192 </a>
 193     </div>
 194
 195   <ul class="md-nav__list" data-md-scrollfix>
 196
 197
 198
 199
 200
 201
 202
 203
 204     <li class="md-nav__item">
 205       <a href="../../getting-started/" class="md-nav__link">
 206         Getting Started
 207       </a>
 208     </li>
 209
 210
 211
 212
 213
 214
 215
 216
 217
 218
 219
 220     <li class="md-nav__item md-nav__item--nested">
 221
 222
 223         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_2" type="checkbox" id="__nav_2" >
 224
 225       <label class="md-nav__link" for="__nav_2">
 226         PHP API
 227         <span class="md-nav__icon md-icon"></span>
 228       </label>
 229       <nav class="md-nav" aria-label="PHP API" data-md-level="1">
 230         <label class="md-nav__title" for="__nav_2">
 231           <span class="md-nav__icon md-icon"></span>
 232           PHP API
 233         </label>
 234         <ul class="md-nav__list" data-md-scrollfix>
 235
 236
 237
 238
 239
 240     <li class="md-nav__item">
 241       <a href="../../php/pages/" class="md-nav__link">
 242         Pages
 243       </a>
 244     </li>
 245
 246
 247
 248
 249
 250
 251
 252     <li class="md-nav__item">
 253       <a href="../../php/database-objects/" class="md-nav__link">
 254         Database Objects
 255       </a>
 256     </li>
 257
 258
 259
 260
 261
 262
 263
 264     <li class="md-nav__item">
 265       <a href="../../php/database-access/" class="md-nav__link">
 266         Database Access
 267       </a>
 268     </li>
 269
 270
 271
 272
 273
 274
 275
 276     <li class="md-nav__item">
 277       <a href="../../php/exceptions/" class="md-nav__link">
 278         Exceptions
 279       </a>
 280     </li>
 281
 282
 283
 284
 285
 286
 287
 288
 289     <li class="md-nav__item md-nav__item--nested">
 290
 291
 292         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_2_5" type="checkbox" id="__nav_2_5" >
 293
 294       <label class="md-nav__link" for="__nav_2_5">
 295         API
 296         <span class="md-nav__icon md-icon"></span>
 297       </label>
 298       <nav class="md-nav" aria-label="API" data-md-level="2">
 299         <label class="md-nav__title" for="__nav_2_5">
 300           <span class="md-nav__icon md-icon"></span>
 301           API
 302         </label>
 303         <ul class="md-nav__list" data-md-scrollfix>
 304
 305
 306
 307
 308
 309
 310     <li class="md-nav__item md-nav__item--nested">
 311
 312
 313         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_2_5_1" type="checkbox" id="__nav_2_5_1" >
 314
 315       <label class="md-nav__link" for="__nav_2_5_1">
 316         Caches
 317         <span class="md-nav__icon md-icon"></span>
 318       </label>
 319       <nav class="md-nav" aria-label="Caches" data-md-level="3">
 320         <label class="md-nav__title" for="__nav_2_5_1">
 321           <span class="md-nav__icon md-icon"></span>
 322           Caches
 323         </label>
 324         <ul class="md-nav__list" data-md-scrollfix>
 325
 326
 327
 328
 329
 330     <li class="md-nav__item">
 331       <a href="../../php/api/caches/" class="md-nav__link">
 332         Overview
 333       </a>
 334     </li>
 335
 336
 337
 338
 339
 340
 341
 342     <li class="md-nav__item">
 343       <a href="../../php/api/caches_persistent-caches/" class="md-nav__link">
 344         Persistent Caches
 345       </a>
 346     </li>
 347
 348
 349
 350
 351
 352
 353
 354     <li class="md-nav__item">
 355       <a href="../../php/api/caches_runtime-caches/" class="md-nav__link">
 356         Runtime Caches
 357       </a>
 358     </li>
 359
 360
 361
 362         </ul>
 363       </nav>
 364     </li>
 365
 366
 367
 368
 369
 370
 371
 372     <li class="md-nav__item">
 373       <a href="../../php/api/comments/" class="md-nav__link">
 374         Comments
 375       </a>
 376     </li>
 377
 378
 379
 380
 381
 382
 383
 384     <li class="md-nav__item">
 385       <a href="../../php/api/cronjobs/" class="md-nav__link">
 386         Cronjobs
 387       </a>
 388     </li>
 389
 390
 391
 392
 393
 394
 395
 396     <li class="md-nav__item">
 397       <a href="../../php/api/events/" class="md-nav__link">
 398         Events
 399       </a>
 400     </li>
 401
 402
 403
 404
 405
 406
 407
 408
 409     <li class="md-nav__item md-nav__item--nested">
 410
 411
 412         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_2_5_5" type="checkbox" id="__nav_2_5_5" >
 413
 414       <label class="md-nav__link" for="__nav_2_5_5">
 415         Form Builder
 416         <span class="md-nav__icon md-icon"></span>
 417       </label>
 418       <nav class="md-nav" aria-label="Form Builder" data-md-level="3">
 419         <label class="md-nav__title" for="__nav_2_5_5">
 420           <span class="md-nav__icon md-icon"></span>
 421           Form Builder
 422         </label>
 423         <ul class="md-nav__list" data-md-scrollfix>
 424
 425
 426
 427
 428
 429     <li class="md-nav__item">
 430       <a href="../../php/api/form_builder/overview/" class="md-nav__link">
 431         Overview
 432       </a>
 433     </li>
 434
 435
 436
 437
 438
 439
 440
 441     <li class="md-nav__item">
 442       <a href="../../php/api/form_builder/structure/" class="md-nav__link">
 443         Structure
 444       </a>
 445     </li>
 446
 447
 448
 449
 450
 451
 452
 453     <li class="md-nav__item">
 454       <a href="../../php/api/form_builder/form_fields/" class="md-nav__link">
 455         Fields
 456       </a>
 457     </li>
 458
 459
 460
 461
 462
 463
 464
 465     <li class="md-nav__item">
 466       <a href="../../php/api/form_builder/validation_data/" class="md-nav__link">
 467         Validation and Data
 468       </a>
 469     </li>
 470
 471
 472
 473
 474
 475
 476
 477     <li class="md-nav__item">
 478       <a href="../../php/api/form_builder/dependencies/" class="md-nav__link">
 479         Dependencies
 480       </a>
 481     </li>
 482
 483
 484
 485         </ul>
 486       </nav>
 487     </li>
 488
 489
 490
 491
 492
 493
 494
 495     <li class="md-nav__item">
 496       <a href="../../php/api/package_installation_plugins/" class="md-nav__link">
 497         Package Installation Plugins
 498       </a>
 499     </li>
 500
 501
 502
 503
 504
 505
 506
 507     <li class="md-nav__item">
 508       <a href="../../php/api/user_activity_points/" class="md-nav__link">
 509         User Activity Points
 510       </a>
 511     </li>
 512
 513
 514
 515
 516
 517
 518
 519     <li class="md-nav__item">
 520       <a href="../../php/api/user_notifications/" class="md-nav__link">
 521         User Notifications
 522       </a>
 523     </li>
 524
 525
 526
 527
 528
 529
 530
 531     <li class="md-nav__item">
 532       <a href="../../php/api/sitemaps/" class="md-nav__link">
 533         Sitemaps
 534       </a>
 535     </li>
 536
 537
 538
 539         </ul>
 540       </nav>
 541     </li>
 542
 543
 544
 545
 546
 547
 548
 549     <li class="md-nav__item">
 550       <a href="../../php/code-style/" class="md-nav__link">
 551         Code Style
 552       </a>
 553     </li>
 554
 555
 556
 557
 558
 559
 560
 561     <li class="md-nav__item">
 562       <a href="../../php/apps/" class="md-nav__link">
 563         Apps
 564       </a>
 565     </li>
 566
 567
 568
 569
 570
 571
 572
 573     <li class="md-nav__item">
 574       <a href="../../php/gdpr/" class="md-nav__link">
 575         GDPR
 576       </a>
 577     </li>
 578
 579
 580
 581         </ul>
 582       </nav>
 583     </li>
 584
 585
 586
 587
 588
 589
 590
 591
 592
 593
 594
 595     <li class="md-nav__item md-nav__item--nested">
 596
 597
 598         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_3" type="checkbox" id="__nav_3" >
 599
 600       <label class="md-nav__link" for="__nav_3">
 601         Languages, Templates & CSS
 602         <span class="md-nav__icon md-icon"></span>
 603       </label>
 604       <nav class="md-nav" aria-label="Languages, Templates & CSS" data-md-level="1">
 605         <label class="md-nav__title" for="__nav_3">
 606           <span class="md-nav__icon md-icon"></span>
 607           Languages, Templates & CSS
 608         </label>
 609         <ul class="md-nav__list" data-md-scrollfix>
 610
 611
 612
 613
 614
 615     <li class="md-nav__item">
 616       <a href="../../view/languages/" class="md-nav__link">
 617         Languages
 618       </a>
 619     </li>
 620
 621
 622
 623
 624
 625
 626
 627     <li class="md-nav__item">
 628       <a href="../../view/templates/" class="md-nav__link">
 629         Templates
 630       </a>
 631     </li>
 632
 633
 634
 635
 636
 637
 638
 639     <li class="md-nav__item">
 640       <a href="../../view/template-plugins/" class="md-nav__link">
 641         Template Plugins
 642       </a>
 643     </li>
 644
 645
 646
 647
 648
 649
 650
 651     <li class="md-nav__item">
 652       <a href="../../view/css/" class="md-nav__link">
 653         CSS
 654       </a>
 655     </li>
 656
 657
 658
 659         </ul>
 660       </nav>
 661     </li>
 662
 663
 664
 665
 666
 667
 668
 669
 670
 671
 672
 673
 674
 675     <li class="md-nav__item md-nav__item--active md-nav__item--nested">
 676
 677
 678         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_4" type="checkbox" id="__nav_4" checked>
 679
 680       <label class="md-nav__link" for="__nav_4">
 681         TypeScript and JavaScript API
 682         <span class="md-nav__icon md-icon"></span>
 683       </label>
 684       <nav class="md-nav" aria-label="TypeScript and JavaScript API" data-md-level="1">
 685         <label class="md-nav__title" for="__nav_4">
 686           <span class="md-nav__icon md-icon"></span>
 687           TypeScript and JavaScript API
 688         </label>
 689         <ul class="md-nav__list" data-md-scrollfix>
 690
 691
 692
 693
 694
 695     <li class="md-nav__item">
 696       <a href="../general-usage/" class="md-nav__link">
 697         General Usage
 698       </a>
 699     </li>
 700
 701
 702
 703
 704
 705
 706
 707     <li class="md-nav__item">
 708       <a href="../typescript/" class="md-nav__link">
 709         TypeScript
 710       </a>
 711     </li>
 712
 713
 714
 715
 716
 717
 718
 719
 720
 721
 722     <li class="md-nav__item md-nav__item--active md-nav__item--nested">
 723
 724
 725         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_4_3" type="checkbox" id="__nav_4_3" checked>
 726
 727       <label class="md-nav__link" for="__nav_4_3">
 728         New API
 729         <span class="md-nav__icon md-icon"></span>
 730       </label>
 731       <nav class="md-nav" aria-label="New API" data-md-level="2">
 732         <label class="md-nav__title" for="__nav_4_3">
 733           <span class="md-nav__icon md-icon"></span>
 734           New API
 735         </label>
 736         <ul class="md-nav__list" data-md-scrollfix>
 737
 738
 739
 740
 741
 742     <li class="md-nav__item">
 743       <a href="../new-api_writing-a-module/" class="md-nav__link">
 744         Writing a module
 745       </a>
 746     </li>
 747
 748
 749
 750
 751
 752
 753
 754     <li class="md-nav__item">
 755       <a href="../new-api_data-structures/" class="md-nav__link">
 756         Data Structures
 757       </a>
 758     </li>
 759
 760
 761
 762
 763
 764
 765
 766     <li class="md-nav__item">
 767       <a href="../new-api_core/" class="md-nav__link">
 768         Core Functions
 769       </a>
 770     </li>
 771
 772
 773
 774
 775
 776
 777
 778     <li class="md-nav__item">
 779       <a href="../new-api_dom/" class="md-nav__link">
 780         DOM
 781       </a>
 782     </li>
 783
 784
 785
 786
 787
 788
 789
 790     <li class="md-nav__item">
 791       <a href="../new-api_events/" class="md-nav__link">
 792         Event Handling
 793       </a>
 794     </li>
 795
 796
 797
 798
 799
 800
 801
 802
 803
 804     <li class="md-nav__item md-nav__item--active">
 805
 806       <input class="md-nav__toggle md-toggle" data-md-toggle="toc" type="checkbox" id="__toc">
 807
 808
 809
 810
 811
 812         <label class="md-nav__link md-nav__link--active" for="__toc">
 813           Ajax
 814           <span class="md-nav__icon md-icon"></span>
 815         </label>
 816
 817       <a href="./" class="md-nav__link md-nav__link--active">
 818         Ajax
 819       </a>
 820
 821
 822 <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
 823
 824
 825
 826
 827
 828
 829     <label class="md-nav__title" for="__toc">
 830       <span class="md-nav__icon md-icon"></span>
 831       Table of contents
 832     </label>
 833     <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
 834
 835         <li class="md-nav__item">
 836   <a href="#ajax-inside-modules" class="md-nav__link">
 837     Ajax inside Modules
 838   </a>
 839
 840     <nav class="md-nav" aria-label="Ajax inside Modules">
 841       <ul class="md-nav__list">
 842
 843           <li class="md-nav__item">
 844   <a href="#_ajaxsetup" class="md-nav__link">
 845     _ajaxSetup()
 846   </a>
 847
 848 </li>
 849
 850           <li class="md-nav__item">
 851   <a href="#request-settings" class="md-nav__link">
 852     Request Settings
 853   </a>
 854
 855     <nav class="md-nav" aria-label="Request Settings">
 856       <ul class="md-nav__list">
 857
 858           <li class="md-nav__item">
 859   <a href="#data" class="md-nav__link">
 860     data
 861   </a>
 862
 863 </li>
 864
 865           <li class="md-nav__item">
 866   <a href="#contenttype" class="md-nav__link">
 867     contentType
 868   </a>
 869
 870 </li>
 871
 872           <li class="md-nav__item">
 873   <a href="#responsetype" class="md-nav__link">
 874     responseType
 875   </a>
 876
 877 </li>
 878
 879           <li class="md-nav__item">
 880   <a href="#type" class="md-nav__link">
 881     type
 882   </a>
 883
 884 </li>
 885
 886           <li class="md-nav__item">
 887   <a href="#url" class="md-nav__link">
 888     url
 889   </a>
 890
 891 </li>
 892
 893           <li class="md-nav__item">
 894   <a href="#withcredentials" class="md-nav__link">
 895     withCredentials
 896   </a>
 897
 898 </li>
 899
 900           <li class="md-nav__item">
 901   <a href="#autoabort" class="md-nav__link">
 902     autoAbort
 903   </a>
 904
 905 </li>
 906
 907           <li class="md-nav__item">
 908   <a href="#ignoreerror" class="md-nav__link">
 909     ignoreError
 910   </a>
 911
 912 </li>
 913
 914           <li class="md-nav__item">
 915   <a href="#silent" class="md-nav__link">
 916     silent
 917   </a>
 918
 919 </li>
 920
 921           <li class="md-nav__item">
 922   <a href="#includerequestedwith" class="md-nav__link">
 923     includeRequestedWith
 924   </a>
 925
 926 </li>
 927
 928           <li class="md-nav__item">
 929   <a href="#failure" class="md-nav__link">
 930     failure
 931   </a>
 932
 933 </li>
 934
 935           <li class="md-nav__item">
 936   <a href="#finalize" class="md-nav__link">
 937     finalize
 938   </a>
 939
 940 </li>
 941
 942           <li class="md-nav__item">
 943   <a href="#success" class="md-nav__link">
 944     success
 945   </a>
 946
 947 </li>
 948
 949       </ul>
 950     </nav>
 951
 952 </li>
 953
 954           <li class="md-nav__item">
 955   <a href="#_ajaxsuccess" class="md-nav__link">
 956     _ajaxSuccess()
 957   </a>
 958
 959 </li>
 960
 961           <li class="md-nav__item">
 962   <a href="#_ajaxfailure" class="md-nav__link">
 963     _ajaxFailure()
 964   </a>
 965
 966 </li>
 967
 968       </ul>
 969     </nav>
 970
 971 </li>
 972
 973         <li class="md-nav__item">
 974   <a href="#single-requests-without-a-module" class="md-nav__link">
 975     Single Requests Without a Module
 976   </a>
 977
 978 </li>
 979
 980     </ul>
 981
 982 </nav>
 983
 984     </li>
 985
 986
 987
 988
 989
 990
 991
 992     <li class="md-nav__item">
 993       <a href="../new-api_dialogs/" class="md-nav__link">
 994         Dialogs
 995       </a>
 996     </li>
 997
 998
 999
1000
1001
1002
1003
1004     <li class="md-nav__item">
1005       <a href="../new-api_browser/" class="md-nav__link">
1006         Browser and Screen Sizes
1007       </a>
1008     </li>
1009
1010
1011
1012
1013
1014
1015
1016     <li class="md-nav__item">
1017       <a href="../new-api_ui/" class="md-nav__link">
1018         User Interface
1019       </a>
1020     </li>
1021
1022
1023
1024         </ul>
1025       </nav>
1026     </li>
1027
1028
1029
1030
1031
1032
1033
1034     <li class="md-nav__item">
1035       <a href="../legacy-api/" class="md-nav__link">
1036         Legacy API
1037       </a>
1038     </li>
1039
1040
1041
1042
1043
1044
1045
1046     <li class="md-nav__item">
1047       <a href="../helper-functions/" class="md-nav__link">
1048         Helper Functions
1049       </a>
1050     </li>
1051
1052
1053
1054
1055
1056
1057
1058     <li class="md-nav__item">
1059       <a href="../code-snippets/" class="md-nav__link">
1060         Code Snippets
1061       </a>
1062     </li>
1063
1064
1065
1066         </ul>
1067       </nav>
1068     </li>
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080     <li class="md-nav__item md-nav__item--nested">
1081
1082
1083         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5" type="checkbox" id="__nav_5" >
1084
1085       <label class="md-nav__link" for="__nav_5">
1086         Package Components
1087         <span class="md-nav__icon md-icon"></span>
1088       </label>
1089       <nav class="md-nav" aria-label="Package Components" data-md-level="1">
1090         <label class="md-nav__title" for="__nav_5">
1091           <span class="md-nav__icon md-icon"></span>
1092           Package Components
1093         </label>
1094         <ul class="md-nav__list" data-md-scrollfix>
1095
1096
1097
1098
1099
1100     <li class="md-nav__item">
1101       <a href="../../package/package-xml/" class="md-nav__link">
1102         package.xml
1103       </a>
1104     </li>
1105
1106
1107
1108
1109
1110
1111
1112
1113     <li class="md-nav__item md-nav__item--nested">
1114
1115
1116         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_2" type="checkbox" id="__nav_5_2" >
1117
1118       <label class="md-nav__link" for="__nav_5_2">
1119         PIPs
1120         <span class="md-nav__icon md-icon"></span>
1121       </label>
1122       <nav class="md-nav" aria-label="PIPs" data-md-level="2">
1123         <label class="md-nav__title" for="__nav_5_2">
1124           <span class="md-nav__icon md-icon"></span>
1125           PIPs
1126         </label>
1127         <ul class="md-nav__list" data-md-scrollfix>
1128
1129
1130
1131
1132
1133     <li class="md-nav__item">
1134       <a href="../../package/pip/" class="md-nav__link">
1135         Overview
1136       </a>
1137     </li>
1138
1139
1140
1141
1142
1143
1144
1145     <li class="md-nav__item">
1146       <a href="../../package/pip/acl-option/" class="md-nav__link">
1147         aclOption
1148       </a>
1149     </li>
1150
1151
1152
1153
1154
1155
1156
1157     <li class="md-nav__item">
1158       <a href="../../package/pip/acp-menu/" class="md-nav__link">
1159         acpMenu
1160       </a>
1161     </li>
1162
1163
1164
1165
1166
1167
1168
1169     <li class="md-nav__item">
1170       <a href="../../package/pip/acp-search-provider/" class="md-nav__link">
1171         acpSearchProvider
1172       </a>
1173     </li>
1174
1175
1176
1177
1178
1179
1180
1181     <li class="md-nav__item">
1182       <a href="../../package/pip/acp-template/" class="md-nav__link">
1183         acpTemplate
1184       </a>
1185     </li>
1186
1187
1188
1189
1190
1191
1192
1193     <li class="md-nav__item">
1194       <a href="../../package/pip/bbcode/" class="md-nav__link">
1195         bbcode
1196       </a>
1197     </li>
1198
1199
1200
1201
1202
1203
1204
1205     <li class="md-nav__item">
1206       <a href="../../package/pip/box/" class="md-nav__link">
1207         box
1208       </a>
1209     </li>
1210
1211
1212
1213
1214
1215
1216
1217     <li class="md-nav__item">
1218       <a href="../../package/pip/clipboard-action/" class="md-nav__link">
1219         clipboardAction
1220       </a>
1221     </li>
1222
1223
1224
1225
1226
1227
1228
1229     <li class="md-nav__item">
1230       <a href="../../package/pip/core-object/" class="md-nav__link">
1231         coreObject
1232       </a>
1233     </li>
1234
1235
1236
1237
1238
1239
1240
1241     <li class="md-nav__item">
1242       <a href="../../package/pip/cronjob/" class="md-nav__link">
1243         cronjob
1244       </a>
1245     </li>
1246
1247
1248
1249
1250
1251
1252
1253     <li class="md-nav__item">
1254       <a href="../../package/pip/database/" class="md-nav__link">
1255         database
1256       </a>
1257     </li>
1258
1259
1260
1261
1262
1263
1264
1265     <li class="md-nav__item">
1266       <a href="../../package/pip/event-listener/" class="md-nav__link">
1267         eventListener
1268       </a>
1269     </li>
1270
1271
1272
1273
1274
1275
1276
1277     <li class="md-nav__item">
1278       <a href="../../package/pip/file/" class="md-nav__link">
1279         file
1280       </a>
1281     </li>
1282
1283
1284
1285
1286
1287
1288
1289     <li class="md-nav__item">
1290       <a href="../../package/pip/language/" class="md-nav__link">
1291         language
1292       </a>
1293     </li>
1294
1295
1296
1297
1298
1299
1300
1301     <li class="md-nav__item">
1302       <a href="../../package/pip/media-provider/" class="md-nav__link">
1303         mediaProvider
1304       </a>
1305     </li>
1306
1307
1308
1309
1310
1311
1312
1313     <li class="md-nav__item">
1314       <a href="../../package/pip/menu/" class="md-nav__link">
1315         menu
1316       </a>
1317     </li>
1318
1319
1320
1321
1322
1323
1324
1325     <li class="md-nav__item">
1326       <a href="../../package/pip/menu-item/" class="md-nav__link">
1327         menuItem
1328       </a>
1329     </li>
1330
1331
1332
1333
1334
1335
1336
1337     <li class="md-nav__item">
1338       <a href="../../package/pip/object-type/" class="md-nav__link">
1339         objectType
1340       </a>
1341     </li>
1342
1343
1344
1345
1346
1347
1348
1349     <li class="md-nav__item">
1350       <a href="../../package/pip/object-type-definition/" class="md-nav__link">
1351         objectTypeDefinition
1352       </a>
1353     </li>
1354
1355
1356
1357
1358
1359
1360
1361     <li class="md-nav__item">
1362       <a href="../../package/pip/option/" class="md-nav__link">
1363         option
1364       </a>
1365     </li>
1366
1367
1368
1369
1370
1371
1372
1373     <li class="md-nav__item">
1374       <a href="../../package/pip/page/" class="md-nav__link">
1375         page
1376       </a>
1377     </li>
1378
1379
1380
1381
1382
1383
1384
1385     <li class="md-nav__item">
1386       <a href="../../package/pip/pip/" class="md-nav__link">
1387         pip
1388       </a>
1389     </li>
1390
1391
1392
1393
1394
1395
1396
1397     <li class="md-nav__item">
1398       <a href="../../package/pip/script/" class="md-nav__link">
1399         script
1400       </a>
1401     </li>
1402
1403
1404
1405
1406
1407
1408
1409     <li class="md-nav__item">
1410       <a href="../../package/pip/smiley/" class="md-nav__link">
1411         smiley
1412       </a>
1413     </li>
1414
1415
1416
1417
1418
1419
1420
1421     <li class="md-nav__item">
1422       <a href="../../package/pip/sql/" class="md-nav__link">
1423         sql
1424       </a>
1425     </li>
1426
1427
1428
1429
1430
1431
1432
1433     <li class="md-nav__item">
1434       <a href="../../package/pip/style/" class="md-nav__link">
1435         style
1436       </a>
1437     </li>
1438
1439
1440
1441
1442
1443
1444
1445     <li class="md-nav__item">
1446       <a href="../../package/pip/template/" class="md-nav__link">
1447         template
1448       </a>
1449     </li>
1450
1451
1452
1453
1454
1455
1456
1457     <li class="md-nav__item">
1458       <a href="../../package/pip/template-listener/" class="md-nav__link">
1459         templateListener
1460       </a>
1461     </li>
1462
1463
1464
1465
1466
1467
1468
1469     <li class="md-nav__item">
1470       <a href="../../package/pip/user-group-option/" class="md-nav__link">
1471         userGroupOption
1472       </a>
1473     </li>
1474
1475
1476
1477
1478
1479
1480
1481     <li class="md-nav__item">
1482       <a href="../../package/pip/user-menu/" class="md-nav__link">
1483         userMenu
1484       </a>
1485     </li>
1486
1487
1488
1489
1490
1491
1492
1493     <li class="md-nav__item">
1494       <a href="../../package/pip/user-notification-event/" class="md-nav__link">
1495         userNotificationEvent
1496       </a>
1497     </li>
1498
1499
1500
1501
1502
1503
1504
1505     <li class="md-nav__item">
1506       <a href="../../package/pip/user-option/" class="md-nav__link">
1507         userOption
1508       </a>
1509     </li>
1510
1511
1512
1513
1514
1515
1516
1517     <li class="md-nav__item">
1518       <a href="../../package/pip/user-profile-menu/" class="md-nav__link">
1519         userProfileMenu
1520       </a>
1521     </li>
1522
1523
1524
1525         </ul>
1526       </nav>
1527     </li>
1528
1529
1530
1531
1532
1533
1534
1535     <li class="md-nav__item">
1536       <a href="../../package/database-php-api/" class="md-nav__link">
1537         Database PHP API
1538       </a>
1539     </li>
1540
1541
1542
1543         </ul>
1544       </nav>
1545     </li>
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557     <li class="md-nav__item md-nav__item--nested">
1558
1559
1560         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6" type="checkbox" id="__nav_6" >
1561
1562       <label class="md-nav__link" for="__nav_6">
1563         Migration
1564         <span class="md-nav__icon md-icon"></span>
1565       </label>
1566       <nav class="md-nav" aria-label="Migration" data-md-level="1">
1567         <label class="md-nav__title" for="__nav_6">
1568           <span class="md-nav__icon md-icon"></span>
1569           Migration
1570         </label>
1571         <ul class="md-nav__list" data-md-scrollfix>
1572
1573
1574
1575
1576
1577
1578     <li class="md-nav__item md-nav__item--nested">
1579
1580
1581         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_1" type="checkbox" id="__nav_6_1" >
1582
1583       <label class="md-nav__link" for="__nav_6_1">
1584         Migrating from WSC 5.3
1585         <span class="md-nav__icon md-icon"></span>
1586       </label>
1587       <nav class="md-nav" aria-label="Migrating from WSC 5.3" data-md-level="2">
1588         <label class="md-nav__title" for="__nav_6_1">
1589           <span class="md-nav__icon md-icon"></span>
1590           Migrating from WSC 5.3
1591         </label>
1592         <ul class="md-nav__list" data-md-scrollfix>
1593
1594
1595
1596
1597
1598     <li class="md-nav__item">
1599       <a href="../../migration/wsc53/php/" class="md-nav__link">
1600         PHP API
1601       </a>
1602     </li>
1603
1604
1605
1606
1607
1608
1609
1610     <li class="md-nav__item">
1611       <a href="../../migration/wsc53/session/" class="md-nav__link">
1612         Session Handling and Authentication
1613       </a>
1614     </li>
1615
1616
1617
1618
1619
1620
1621
1622     <li class="md-nav__item">
1623       <a href="../../migration/wsc53/javascript/" class="md-nav__link">
1624         TypeScript and JavaScript
1625       </a>
1626     </li>
1627
1628
1629
1630
1631
1632
1633
1634     <li class="md-nav__item">
1635       <a href="../../migration/wsc53/templates/" class="md-nav__link">
1636         Templates
1637       </a>
1638     </li>
1639
1640
1641
1642
1643
1644
1645
1646     <li class="md-nav__item">
1647       <a href="../../migration/wsc53/libraries/" class="md-nav__link">
1648         Third Party Libraries
1649       </a>
1650     </li>
1651
1652
1653
1654         </ul>
1655       </nav>
1656     </li>
1657
1658
1659
1660
1661
1662
1663
1664
1665     <li class="md-nav__item md-nav__item--nested">
1666
1667
1668         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_2" type="checkbox" id="__nav_6_2" >
1669
1670       <label class="md-nav__link" for="__nav_6_2">
1671         Migrating from WSC 5.2
1672         <span class="md-nav__icon md-icon"></span>
1673       </label>
1674       <nav class="md-nav" aria-label="Migrating from WSC 5.2" data-md-level="2">
1675         <label class="md-nav__title" for="__nav_6_2">
1676           <span class="md-nav__icon md-icon"></span>
1677           Migrating from WSC 5.2
1678         </label>
1679         <ul class="md-nav__list" data-md-scrollfix>
1680
1681
1682
1683
1684
1685     <li class="md-nav__item">
1686       <a href="../../migration/wsc52/php/" class="md-nav__link">
1687         PHP API
1688       </a>
1689     </li>
1690
1691
1692
1693
1694
1695
1696
1697     <li class="md-nav__item">
1698       <a href="../../migration/wsc52/templates/" class="md-nav__link">
1699         Templates and Languages
1700       </a>
1701     </li>
1702
1703
1704
1705
1706
1707
1708
1709     <li class="md-nav__item">
1710       <a href="../../migration/wsc52/libraries/" class="md-nav__link">
1711         Third Party Libraries
1712       </a>
1713     </li>
1714
1715
1716
1717         </ul>
1718       </nav>
1719     </li>
1720
1721
1722
1723
1724
1725
1726
1727
1728     <li class="md-nav__item md-nav__item--nested">
1729
1730
1731         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_3" type="checkbox" id="__nav_6_3" >
1732
1733       <label class="md-nav__link" for="__nav_6_3">
1734         Migrating from WSC 3.1
1735         <span class="md-nav__icon md-icon"></span>
1736       </label>
1737       <nav class="md-nav" aria-label="Migrating from WSC 3.1" data-md-level="2">
1738         <label class="md-nav__title" for="__nav_6_3">
1739           <span class="md-nav__icon md-icon"></span>
1740           Migrating from WSC 3.1
1741         </label>
1742         <ul class="md-nav__list" data-md-scrollfix>
1743
1744
1745
1746
1747
1748     <li class="md-nav__item">
1749       <a href="../../migration/wsc31/php/" class="md-nav__link">
1750         PHP API
1751       </a>
1752     </li>
1753
1754
1755
1756         </ul>
1757       </nav>
1758     </li>
1759
1760
1761
1762
1763
1764
1765
1766
1767     <li class="md-nav__item md-nav__item--nested">
1768
1769
1770         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_4" type="checkbox" id="__nav_6_4" >
1771
1772       <label class="md-nav__link" for="__nav_6_4">
1773         Migrating from WSC 3.0
1774         <span class="md-nav__icon md-icon"></span>
1775       </label>
1776       <nav class="md-nav" aria-label="Migrating from WSC 3.0" data-md-level="2">
1777         <label class="md-nav__title" for="__nav_6_4">
1778           <span class="md-nav__icon md-icon"></span>
1779           Migrating from WSC 3.0
1780         </label>
1781         <ul class="md-nav__list" data-md-scrollfix>
1782
1783
1784
1785
1786
1787     <li class="md-nav__item">
1788       <a href="../../migration/wsc30/php/" class="md-nav__link">
1789         PHP API
1790       </a>
1791     </li>
1792
1793
1794
1795
1796
1797
1798
1799     <li class="md-nav__item">
1800       <a href="../../migration/wsc30/javascript/" class="md-nav__link">
1801         JavaScript API
1802       </a>
1803     </li>
1804
1805
1806
1807
1808
1809
1810
1811     <li class="md-nav__item">
1812       <a href="../../migration/wsc30/templates/" class="md-nav__link">
1813         Templates
1814       </a>
1815     </li>
1816
1817
1818
1819
1820
1821
1822
1823     <li class="md-nav__item">
1824       <a href="../../migration/wsc30/css/" class="md-nav__link">
1825         CSS
1826       </a>
1827     </li>
1828
1829
1830
1831
1832
1833
1834
1835     <li class="md-nav__item">
1836       <a href="../../migration/wsc30/package/" class="md-nav__link">
1837         Package Components
1838       </a>
1839     </li>
1840
1841
1842
1843         </ul>
1844       </nav>
1845     </li>
1846
1847
1848
1849
1850
1851
1852
1853
1854     <li class="md-nav__item md-nav__item--nested">
1855
1856
1857         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_5" type="checkbox" id="__nav_6_5" >
1858
1859       <label class="md-nav__link" for="__nav_6_5">
1860         Migrating from WCF 2.1
1861         <span class="md-nav__icon md-icon"></span>
1862       </label>
1863       <nav class="md-nav" aria-label="Migrating from WCF 2.1" data-md-level="2">
1864         <label class="md-nav__title" for="__nav_6_5">
1865           <span class="md-nav__icon md-icon"></span>
1866           Migrating from WCF 2.1
1867         </label>
1868         <ul class="md-nav__list" data-md-scrollfix>
1869
1870
1871
1872
1873
1874     <li class="md-nav__item">
1875       <a href="../../migration/wcf21/php/" class="md-nav__link">
1876         PHP API
1877       </a>
1878     </li>
1879
1880
1881
1882
1883
1884
1885
1886     <li class="md-nav__item">
1887       <a href="../../migration/wcf21/templates/" class="md-nav__link">
1888         Templates
1889       </a>
1890     </li>
1891
1892
1893
1894
1895
1896
1897
1898     <li class="md-nav__item">
1899       <a href="../../migration/wcf21/css/" class="md-nav__link">
1900         CSS
1901       </a>
1902     </li>
1903
1904
1905
1906
1907
1908
1909
1910     <li class="md-nav__item">
1911       <a href="../../migration/wcf21/package/" class="md-nav__link">
1912         Package Components
1913       </a>
1914     </li>
1915
1916
1917
1918         </ul>
1919       </nav>
1920     </li>
1921
1922
1923
1924         </ul>
1925       </nav>
1926     </li>
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938     <li class="md-nav__item md-nav__item--nested">
1939
1940
1941         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_7" type="checkbox" id="__nav_7" >
1942
1943       <label class="md-nav__link" for="__nav_7">
1944         Tutorials
1945         <span class="md-nav__icon md-icon"></span>
1946       </label>
1947       <nav class="md-nav" aria-label="Tutorials" data-md-level="1">
1948         <label class="md-nav__title" for="__nav_7">
1949           <span class="md-nav__icon md-icon"></span>
1950           Tutorials
1951         </label>
1952         <ul class="md-nav__list" data-md-scrollfix>
1953
1954
1955
1956
1957
1958
1959     <li class="md-nav__item md-nav__item--nested">
1960
1961
1962         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_7_1" type="checkbox" id="__nav_7_1" >
1963
1964       <label class="md-nav__link" for="__nav_7_1">
1965         Tutorial Series
1966         <span class="md-nav__icon md-icon"></span>
1967       </label>
1968       <nav class="md-nav" aria-label="Tutorial Series" data-md-level="2">
1969         <label class="md-nav__title" for="__nav_7_1">
1970           <span class="md-nav__icon md-icon"></span>
1971           Tutorial Series
1972         </label>
1973         <ul class="md-nav__list" data-md-scrollfix>
1974
1975
1976
1977
1978
1979     <li class="md-nav__item">
1980       <a href="../../tutorial/series/overview/" class="md-nav__link">
1981         Overview
1982       </a>
1983     </li>
1984
1985
1986
1987
1988
1989
1990
1991     <li class="md-nav__item">
1992       <a href="../../tutorial/series/part_1/" class="md-nav__link">
1993         Part 1
1994       </a>
1995     </li>
1996
1997
1998
1999
2000
2001
2002
2003     <li class="md-nav__item">
2004       <a href="../../tutorial/series/part_2/" class="md-nav__link">
2005         Part 2
2006       </a>
2007     </li>
2008
2009
2010
2011
2012
2013
2014
2015     <li class="md-nav__item">
2016       <a href="../../tutorial/series/part_3/" class="md-nav__link">
2017         Part 3
2018       </a>
2019     </li>
2020
2021
2022
2023
2024
2025
2026
2027     <li class="md-nav__item">
2028       <a href="../../tutorial/series/part_4/" class="md-nav__link">
2029         Part 4
2030       </a>
2031     </li>
2032
2033
2034
2035
2036
2037
2038
2039     <li class="md-nav__item">
2040       <a href="../../tutorial/series/part_5/" class="md-nav__link">
2041         Part 5
2042       </a>
2043     </li>
2044
2045
2046
2047         </ul>
2048       </nav>
2049     </li>
2050
2051
2052
2053         </ul>
2054       </nav>
2055     </li>
2056
2057
2058
2059   </ul>
2060 </nav>
2061                   </div>
2062                 </div>
2063               </div>
2064
2065
2066
2067               <div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
2068                 <div class="md-sidebar__scrollwrap">
2069                   <div class="md-sidebar__inner">
2070
2071 <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
2072
2073
2074
2075
2076
2077
2078     <label class="md-nav__title" for="__toc">
2079       <span class="md-nav__icon md-icon"></span>
2080       Table of contents
2081     </label>
2082     <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
2083
2084         <li class="md-nav__item">
2085   <a href="#ajax-inside-modules" class="md-nav__link">
2086     Ajax inside Modules
2087   </a>
2088
2089     <nav class="md-nav" aria-label="Ajax inside Modules">
2090       <ul class="md-nav__list">
2091
2092           <li class="md-nav__item">
2093   <a href="#_ajaxsetup" class="md-nav__link">
2094     _ajaxSetup()
2095   </a>
2096
2097 </li>
2098
2099           <li class="md-nav__item">
2100   <a href="#request-settings" class="md-nav__link">
2101     Request Settings
2102   </a>
2103
2104     <nav class="md-nav" aria-label="Request Settings">
2105       <ul class="md-nav__list">
2106
2107           <li class="md-nav__item">
2108   <a href="#data" class="md-nav__link">
2109     data
2110   </a>
2111
2112 </li>
2113
2114           <li class="md-nav__item">
2115   <a href="#contenttype" class="md-nav__link">
2116     contentType
2117   </a>
2118
2119 </li>
2120
2121           <li class="md-nav__item">
2122   <a href="#responsetype" class="md-nav__link">
2123     responseType
2124   </a>
2125
2126 </li>
2127
2128           <li class="md-nav__item">
2129   <a href="#type" class="md-nav__link">
2130     type
2131   </a>
2132
2133 </li>
2134
2135           <li class="md-nav__item">
2136   <a href="#url" class="md-nav__link">
2137     url
2138   </a>
2139
2140 </li>
2141
2142           <li class="md-nav__item">
2143   <a href="#withcredentials" class="md-nav__link">
2144     withCredentials
2145   </a>
2146
2147 </li>
2148
2149           <li class="md-nav__item">
2150   <a href="#autoabort" class="md-nav__link">
2151     autoAbort
2152   </a>
2153
2154 </li>
2155
2156           <li class="md-nav__item">
2157   <a href="#ignoreerror" class="md-nav__link">
2158     ignoreError
2159   </a>
2160
2161 </li>
2162
2163           <li class="md-nav__item">
2164   <a href="#silent" class="md-nav__link">
2165     silent
2166   </a>
2167
2168 </li>
2169
2170           <li class="md-nav__item">
2171   <a href="#includerequestedwith" class="md-nav__link">
2172     includeRequestedWith
2173   </a>
2174
2175 </li>
2176
2177           <li class="md-nav__item">
2178   <a href="#failure" class="md-nav__link">
2179     failure
2180   </a>
2181
2182 </li>
2183
2184           <li class="md-nav__item">
2185   <a href="#finalize" class="md-nav__link">
2186     finalize
2187   </a>
2188
2189 </li>
2190
2191           <li class="md-nav__item">
2192   <a href="#success" class="md-nav__link">
2193     success
2194   </a>
2195
2196 </li>
2197
2198       </ul>
2199     </nav>
2200
2201 </li>
2202
2203           <li class="md-nav__item">
2204   <a href="#_ajaxsuccess" class="md-nav__link">
2205     _ajaxSuccess()
2206   </a>
2207
2208 </li>
2209
2210           <li class="md-nav__item">
2211   <a href="#_ajaxfailure" class="md-nav__link">
2212     _ajaxFailure()
2213   </a>
2214
2215 </li>
2216
2217       </ul>
2218     </nav>
2219
2220 </li>
2221
2222         <li class="md-nav__item">
2223   <a href="#single-requests-without-a-module" class="md-nav__link">
2224     Single Requests Without a Module
2225   </a>
2226
2227 </li>
2228
2229     </ul>
2230
2231 </nav>
2232                   </div>
2233                 </div>
2234               </div>
2235
2236
2237           <div class="md-content" data-md-component="content">
2238             <article class="md-content__inner md-typeset">
2239
2240
2241                   <a href="https://github.com/WoltLab/docs.woltlab.com/edit/5.4/docs/javascript/new-api_ajax.md" title="Edit this page" class="md-content__button md-icon">
2242                     <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20.71 7.04c.39-.39.39-1.04 0-1.41l-2.34-2.34c-.37-.39-1.02-.39-1.41 0l-1.84 1.83 3.75 3.75M3 17.25V21h3.75L17.81 9.93l-3.75-3.75L3 17.25z"/></svg>
2243                   </a>
2244
2245
2246                 <h1 id="ajax-requests-javascript-api">Ajax Requests - JavaScript API<a class="headerlink" href="#ajax-requests-javascript-api" title="Permanent link">#</a></h1>
2247 <h2 id="ajax-inside-modules">Ajax inside Modules<a class="headerlink" href="#ajax-inside-modules" title="Permanent link">#</a></h2>
2248 <p>The Ajax component was designed to be used from inside modules where an object
2249 reference is used to delegate request callbacks. This is acomplished through
2250 a set of magic methods that are automatically called when the request is created
2251 or its state has changed.</p>
2252 <h3 id="_ajaxsetup"><code>_ajaxSetup()</code><a class="headerlink" href="#_ajaxsetup" title="Permanent link">#</a></h3>
2253 <p>The lazy initialization is performed upon the first invocation from the callee,
2254 using the magic <code>_ajaxSetup()</code> method to retrieve the basic configuration for
2255 this and any future requests.</p>
2256 <p>The data returned by <code>_ajaxSetup()</code> is cached and the data will be used to
2257 pre-populate the request data before sending it. The callee can overwrite any of
2258 these properties. It is intended to reduce the overhead when issuing request
2259 when these requests share the same properties, such as accessing the same endpoint.</p>
2260 <table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"> 1</span>
2261 <span class="normal"> 2</span>
2262 <span class="normal"> 3</span>
2263 <span class="normal"> 4</span>
2264 <span class="normal"> 5</span>
2265 <span class="normal"> 6</span>
2266 <span class="normal"> 7</span>
2267 <span class="normal"> 8</span>
2268 <span class="normal"> 9</span>
2269 <span class="normal">10</span>
2270 <span class="normal">11</span>
2271 <span class="normal">12</span>
2272 <span class="normal">13</span>
2273 <span class="normal">14</span>
2274 <span class="normal">15</span>
2275 <span class="normal">16</span>
2276 <span class="normal">17</span>
2277 <span class="normal">18</span>
2278 <span class="normal">19</span>
2279 <span class="normal">20</span>
2280 <span class="normal">21</span>
2281 <span class="normal">22</span>
2282 <span class="normal">23</span>
2283 <span class="normal">24</span>
2284 <span class="normal">25</span>
2285 <span class="normal">26</span>
2286 <span class="normal">27</span>
2287 <span class="normal">28</span>
2288 <span class="normal">29</span>
2289 <span class="normal">30</span>
2290 <span class="normal">31</span>
2291 <span class="normal">32</span>
2292 <span class="normal">33</span>
2293 <span class="normal">34</span>
2294 <span class="normal">35</span>
2295 <span class="normal">36</span></pre></div></td><td class="code"><div class="highlight"><pre><span></span><code><span class="c1">// App/Foo.js</span>
2296 <span class="nx">define</span><span class="p">([</span><span class="s2">&quot;Ajax&quot;</span><span class="p">],</span> <span class="kd">function</span><span class="p">(</span><span class="nx">Ajax</span><span class="p">)</span> <span class="p">{</span>
2297   <span class="s2">&quot;use strict&quot;</span><span class="p">;</span>
2298
2299   <span class="kd">function</span> <span class="nx">Foo</span><span class="p">()</span> <span class="p">{};</span>
2300   <span class="nx">Foo</span><span class="p">.</span><span class="nx">prototype</span> <span class="o">=</span> <span class="p">{</span>
2301     <span class="nx">one</span><span class="o">:</span> <span class="kd">function</span><span class="p">()</span> <span class="p">{</span>
2302       <span class="c1">// this will issue an ajax request with the parameter `value` set to `1`</span>
2303       <span class="nx">Ajax</span><span class="p">.</span><span class="nx">api</span><span class="p">(</span><span class="k">this</span><span class="p">);</span>
2304     <span class="p">},</span>
2305
2306     <span class="nx">two</span><span class="o">:</span> <span class="kd">function</span><span class="p">()</span> <span class="p">{</span>
2307       <span class="c1">// this request is almost identical to the one issued with `.one()`, but</span>
2308       <span class="c1">// the value is now set to `2` for this invocation only.</span>
2309       <span class="nx">Ajax</span><span class="p">.</span><span class="nx">api</span><span class="p">(</span><span class="k">this</span><span class="p">,</span> <span class="p">{</span>
2310         <span class="nx">parameters</span><span class="o">:</span> <span class="p">{</span>
2311           <span class="nx">value</span><span class="o">:</span> <span class="mf">2</span>
2312         <span class="p">}</span>
2313       <span class="p">});</span>
2314     <span class="p">},</span>
2315
2316     <span class="nx">_ajaxSetup</span><span class="o">:</span> <span class="kd">function</span><span class="p">()</span> <span class="p">{</span>
2317       <span class="k">return</span> <span class="p">{</span>
2318         <span class="nx">data</span><span class="o">:</span> <span class="p">{</span>
2319           <span class="nx">actionName</span><span class="o">:</span> <span class="s2">&quot;makeSnafucated&quot;</span><span class="p">,</span>
2320           <span class="nx">className</span><span class="o">:</span> <span class="s2">&quot;app\\data\\foo\\FooAction&quot;</span><span class="p">,</span>
2321           <span class="nx">parameters</span><span class="o">:</span> <span class="p">{</span>
2322             <span class="nx">value</span><span class="o">:</span> <span class="mf">1</span>
2323           <span class="p">}</span>
2324         <span class="p">}</span>
2325       <span class="p">}</span>
2326     <span class="p">}</span>
2327   <span class="p">};</span>
2328
2329   <span class="k">return</span> <span class="nx">Foo</span><span class="p">;</span>
2330 <span class="p">});</span>
2331 </code></pre></div>
2332 </td></tr></table>
2333 <h3 id="request-settings">Request Settings<a class="headerlink" href="#request-settings" title="Permanent link">#</a></h3>
2334 <p>The object returned by the aforementioned <code>_ajaxSetup()</code> callback can contain these
2335 values:</p>
2336 <h4 id="data"><code>data</code><a class="headerlink" href="#data" title="Permanent link">#</a></h4>
2337 <p><em>Defaults to <code>{}</code>.</em></p>
2338 <p>A plain JavaScript object that contains the request data that represents the form
2339 data of the request. The <code>parameters</code> key is recognized by the PHP Ajax API and
2340 becomes accessible through <code>$this-&gt;parameters</code>.</p>
2341 <h4 id="contenttype"><code>contentType</code><a class="headerlink" href="#contenttype" title="Permanent link">#</a></h4>
2342 <p><em>Defaults to <code>application/x-www-form-urlencoded; charset=UTF-8</code>.</em></p>
2343 <p>The request content type, sets the <code>Content-Type</code> HTTP header if it is not empty.</p>
2344 <h4 id="responsetype"><code>responseType</code><a class="headerlink" href="#responsetype" title="Permanent link">#</a></h4>
2345 <p><em>Defaults to <code>application/json</code>.</em></p>
2346 <p>The server must respond with the <code>Content-Type</code> HTTP header set to this value,
2347 otherwise the request will be treated as failed. Requests for <code>application/json</code>
2348 will have the return body attempted to be evaluated as JSON.</p>
2349 <p>Other content types will only be validated based on the HTTP header, but no
2350 additional transformation is performed. For example, setting the <code>responseType</code>
2351 to <code>application/xml</code> will check the HTTP header, but will not transform the
2352 <code>data</code> parameter, you'll still receive a string in <code>_ajaxSuccess</code>!</p>
2353 <h4 id="type"><code>type</code><a class="headerlink" href="#type" title="Permanent link">#</a></h4>
2354 <p><em>Defaults to <code>POST</code>.</em></p>
2355 <p>The HTTP Verb used for this request.</p>
2356 <h4 id="url"><code>url</code><a class="headerlink" href="#url" title="Permanent link">#</a></h4>
2357 <p><em>Defaults to an empty string.</em></p>
2358 <p>Manual override for the request endpoint, it will be automatically set to the
2359 Core API endpoint if left empty. If the Core API endpoint is used, the options
2360 <code>includeRequestedWith</code> and <code>withCredentials</code> will be force-set to true.</p>
2361 <h4 id="withcredentials"><code>withCredentials</code><a class="headerlink" href="#withcredentials" title="Permanent link">#</a></h4>
2362 <div class="admonition warning">
2363 <p class="admonition-title">Enabling this parameter for any domain other than the current will trigger a CORS preflight request.</p>
2364 </div>
2365 <p><em>Defaults to <code>false</code>.</em></p>
2366 <p>Include cookies with this requested, is always true when <code>url</code> is (implicitly)
2367 set to the Core API endpoint.</p>
2368 <h4 id="autoabort"><code>autoAbort</code><a class="headerlink" href="#autoabort" title="Permanent link">#</a></h4>
2369 <p><em>Defaults to <code>false</code>.</em></p>
2370 <p>When set to <code>true</code>, any pending responses to earlier requests will be silently
2371 discarded when issuing a new request. This only makes sense if the new request
2372 is meant to completely replace the result of the previous one, regardless of its
2373 reponse body.</p>
2374 <p>Typical use-cases include input field with suggestions, where possible values
2375 are requested from the server, but the input changed faster than the server was
2376 able to reply. In this particular case the client is not interested in the result
2377 for an earlier value, auto-aborting these requests avoids implementing this logic
2378 in the requesting code.</p>
2379 <h4 id="ignoreerror"><code>ignoreError</code><a class="headerlink" href="#ignoreerror" title="Permanent link">#</a></h4>
2380 <p><em>Defaults to <code>false</code>.</em></p>
2381 <p>Any failing request will invoke the <code>failure</code>-callback to check if an error
2382 message should be displayed. Enabling this option will suppress the general
2383 error overlay that reports a failed request.</p>
2384 <p>You can achieve the same result by returning <code>false</code> in the <code>failure</code>-callback.</p>
2385 <h4 id="silent"><code>silent</code><a class="headerlink" href="#silent" title="Permanent link">#</a></h4>
2386 <p><em>Defaults to <code>false</code>.</em></p>
2387 <p>Enabling this option will suppress the loading indicator overlay for this request,
2388 other non-"silent" requests will still trigger the loading indicator.</p>
2389 <h4 id="includerequestedwith"><code>includeRequestedWith</code><a class="headerlink" href="#includerequestedwith" title="Permanent link">#</a></h4>
2390 <div class="admonition warning">
2391 <p class="admonition-title">Enabling this parameter for any domain other than the current will trigger a CORS preflight request.</p>
2392 </div>
2393 <p><em>Defaults to <code>true</code>.</em></p>
2394 <p>Sets the custom HTTP header <code>X-Requested-With: XMLHttpRequest</code> for the request,
2395 it is automatically set to <code>true</code> when <code>url</code> is pointing at the WSC API endpoint.</p>
2396 <h4 id="failure"><code>failure</code><a class="headerlink" href="#failure" title="Permanent link">#</a></h4>
2397 <p><em>Defaults to <code>null</code>.</em></p>
2398 <p>Optional callback function that will be invoked for requests that have failed
2399 for one of these reasons:
2400  1. The request timed out.
2401  2. The HTTP status is not <code>2xx</code> or <code>304</code>.
2402  3. A <code>responseType</code> was set, but the response HTTP header <code>Content-Type</code> did not match the expected value.
2403  4. The <code>responseType</code> was set to <code>application/json</code>, but the response body was not valid JSON.</p>
2404 <p>The callback function receives the parameter <code>xhr</code> (the <code>XMLHttpRequest</code> object)
2405 and <code>options</code> (deep clone of the request parameters). If the callback returns
2406 <code>false</code>, the general error overlay for failed requests will be suppressed.</p>
2407 <p>There will be no error overlay if <code>ignoreError</code> is set to <code>true</code> or if the
2408 request failed while attempting to evaluate the response body as JSON.</p>
2409 <h4 id="finalize"><code>finalize</code><a class="headerlink" href="#finalize" title="Permanent link">#</a></h4>
2410 <p><em>Defaults to <code>null</code>.</em></p>
2411 <p>Optional callback function that will be invoked once the request has completed,
2412 regardless if it succeeded or failed. The only parameter it receives is
2413 <code>options</code> (the request parameters object), but it does not receive the request's
2414 <code>XMLHttpRequest</code>.</p>
2415 <h4 id="success"><code>success</code><a class="headerlink" href="#success" title="Permanent link">#</a></h4>
2416 <p><em>Defaults to <code>null</code>.</em></p>
2417 <p>This semi-optional callback function will always be set to <code>_ajaxSuccess()</code> when
2418 invoking <code>Ajax.api()</code>. It receives four parameters:
2419  1. <code>data</code> - The request's response body as a string, or a JavaScript object if
2420     <code>contentType</code> was set to <code>application/json</code>.
2421  2. <code>responseText</code> - The unmodified response body, it equals the value for <code>data</code>
2422     for non-JSON requests.
2423  3. <code>xhr</code> - The underlying <code>XMLHttpRequest</code> object.
2424  4. <code>requestData</code> - The request parameters that were supplied when the request
2425     was issued.</p>
2426 <h3 id="_ajaxsuccess"><code>_ajaxSuccess()</code><a class="headerlink" href="#_ajaxsuccess" title="Permanent link">#</a></h3>
2427 <p>This callback method is automatically called for successful AJAX requests, it
2428 receives four parameters, with the first one containing either the response body
2429 as a string, or a JavaScript object for JSON requests.</p>
2430 <h3 id="_ajaxfailure"><code>_ajaxFailure()</code><a class="headerlink" href="#_ajaxfailure" title="Permanent link">#</a></h3>
2431 <p>Optional callback function that is invoked for failed requests, it will be
2432 automatically called if the callee implements it, otherwise the global error
2433 handler will be executed.</p>
2434 <h2 id="single-requests-without-a-module">Single Requests Without a Module<a class="headerlink" href="#single-requests-without-a-module" title="Permanent link">#</a></h2>
2435 <p>The <code>Ajax.api()</code> method expects an object that is used to extract the request
2436 configuration as well as providing the callback functions when the request state
2437 changes.</p>
2438 <p>You can issue a simple Ajax request without object binding through <code>Ajax.apiOnce()</code>
2439 that will destroy the instance after the request was finalized. This method is
2440 significantly more expensive for repeated requests and does not offer deriving
2441 modules from altering the behavior. It is strongly  recommended to always use
2442 <code>Ajax.api()</code> for requests to the WSC API endpoint.</p>
2443 <table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"> 1</span>
2444 <span class="normal"> 2</span>
2445 <span class="normal"> 3</span>
2446 <span class="normal"> 4</span>
2447 <span class="normal"> 5</span>
2448 <span class="normal"> 6</span>
2449 <span class="normal"> 7</span>
2450 <span class="normal"> 8</span>
2451 <span class="normal"> 9</span>
2452 <span class="normal">10</span>
2453 <span class="normal">11</span>
2454 <span class="normal">12</span>
2455 <span class="normal">13</span>
2456 <span class="normal">14</span>
2457 <span class="normal">15</span>
2458 <span class="normal">16</span></pre></div></td><td class="code"><div class="highlight"><pre><span></span><code><span class="p">&lt;</span><span class="nt">script</span> <span class="na">data-relocate</span><span class="o">=</span><span class="s">&quot;true&quot;</span><span class="p">&gt;</span>
2459   <span class="nx">require</span><span class="p">([</span><span class="s2">&quot;Ajax&quot;</span><span class="p">],</span> <span class="kd">function</span><span class="p">(</span><span class="nx">Ajax</span><span class="p">)</span> <span class="p">{</span>
2460     <span class="nx">Ajax</span><span class="p">.</span><span class="nx">apiOnce</span><span class="p">({</span>
2461       <span class="nx">data</span><span class="o">:</span> <span class="p">{</span>
2462         <span class="nx">actionName</span><span class="o">:</span> <span class="s2">&quot;makeSnafucated&quot;</span><span class="p">,</span>
2463         <span class="nx">className</span><span class="o">:</span> <span class="s2">&quot;app\\data\\foo\\FooAction&quot;</span><span class="p">,</span>
2464         <span class="nx">parameters</span><span class="o">:</span> <span class="p">{</span>
2465           <span class="nx">value</span><span class="o">:</span> <span class="mf">3</span>
2466         <span class="p">}</span>
2467       <span class="p">},</span>
2468       <span class="nx">success</span><span class="o">:</span> <span class="kd">function</span><span class="p">(</span><span class="nx">data</span><span class="p">)</span> <span class="p">{</span>
2469         <span class="nx">elBySel</span><span class="p">(</span><span class="s2">&quot;.some-element&quot;</span><span class="p">).</span><span class="nx">textContent</span> <span class="o">=</span> <span class="nx">data</span><span class="p">.</span><span class="nx">bar</span><span class="p">;</span>
2470       <span class="p">}</span>
2471     <span class="p">})</span>
2472   <span class="p">});</span>
2473 <span class="p">&lt;/</span><span class="nt">script</span><span class="p">&gt;</span>
2474 </code></pre></div>
2475 </td></tr></table>
2476
2477
2478
2479
2480 <hr>
2481 <div class="md-source-date">
2482   <small>
2483
2484       Last update: 2021-01-08
2485
2486   </small>
2487 </div>
2488
2489
2490
2491
2492
2493
2494
2495
2496             </article>
2497           </div>
2498         </div>
2499
2500       </main>
2501
2502
2503 <footer class="md-footer">
2504
2505     <nav class="md-footer__inner md-grid" aria-label="Footer">
2506
2507         <a href="../new-api_events/" class="md-footer__link md-footer__link--prev" rel="prev">
2508           <div class="md-footer__button md-icon">
2509             <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>
2510           </div>
2511           <div class="md-footer__title">
2512             <div class="md-ellipsis">
2513               <span class="md-footer__direction">
2514                 Previous
2515               </span>
2516               Event Handling
2517             </div>
2518           </div>
2519         </a>
2520
2521
2522         <a href="../new-api_dialogs/" class="md-footer__link md-footer__link--next" rel="next">
2523           <div class="md-footer__title">
2524             <div class="md-ellipsis">
2525               <span class="md-footer__direction">
2526                 Next
2527               </span>
2528               Dialogs
2529             </div>
2530           </div>
2531           <div class="md-footer__button md-icon">
2532             <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M4 11v2h12l-5.5 5.5 1.42 1.42L19.84 12l-7.92-7.92L10.5 5.5 16 11H4z"/></svg>
2533           </div>
2534         </a>
2535
2536     </nav>
2537
2538   <div class="md-footer-meta md-typeset">
2539     <div class="md-footer-meta__inner md-grid">
2540       <div class="md-footer-copyright">
2541
2542           <div class="md-footer-copyright__highlight">
2543             Copyright © 2020 WoltLab GmbH
2544           </div>
2545
2546         Made with
2547         <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
2548           Material for MkDocs
2549         </a>
2550
2551       </div>
2552       <div class="md-footer-copyright">
2553         <a href="https://www.woltlab.com/legal-notice/">Legal Notice</a>
2554         <a href="https://www.woltlab.com/privacy-policy/">Privacy Policy</a>
2555 </div>
2556     </div>
2557   </div>
2558 </footer>
2559
2560     </div>
2561     <div class="md-dialog" data-md-component="dialog">
2562       <div class="md-dialog__inner md-typeset"></div>
2563     </div>
2564     <script id="__config" type="application/json">{"base": "../..", "features": [], "translations": {"clipboard.copy": "Copy to clipboard", "clipboard.copied": "Copied to clipboard", "search.config.lang": "en", "search.config.pipeline": "trimmer, stopWordFilter", "search.config.separator": "[\\s\\-]+", "search.placeholder": "Search", "search.result.placeholder": "Type to start searching", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.term.missing": "Missing"}, "search": "../../assets/javascripts/workers/search.fe42c31b.min.js", "version": {"provider": "mike"}}</script>
2565
2566
2567       <script src="../../assets/javascripts/bundle.4ea5477f.min.js"></script>
2568
2569
2570   </body>
2571 </html>