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.0">
  14
  15
  16
  17         <title>Ajax - WoltLab Suite Documentation</title>
  18
  19
  20
  21       <link rel="stylesheet" href="../../assets/stylesheets/main.33e2939f.min.css">
  22
  23
  24         <link rel="stylesheet" href="../../assets/stylesheets/palette.ef6f36e2.min.css">
  25
  26
  27
  28           <meta name="theme-color" content="#009485">
  29
  30
  31
  32
  33
  34
  35
  36
  37
  38       <link rel="stylesheet" href="../../stylesheets/extra.css">
  39
  40
  41
  42
  43
  44   </head>
  45
  46
  47
  48
  49
  50
  51
  52     <body dir="ltr" data-md-color-scheme="" data-md-color-primary="teal" data-md-color-accent="">
  53
  54
  55     <script>function __prefix(e){return new URL("../..",location).pathname+"."+e}function __get(e,t=localStorage){return JSON.parse(t.getItem(__prefix(e)))}</script>
  56
  57     <input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
  58     <input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
  59     <label class="md-overlay" for="__drawer"></label>
  60     <div data-md-component="skip">
  61
  62
  63         <a href="#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         <label class="md-nav__link md-nav__link--active" for="__toc">
 812           Ajax
 813           <span class="md-nav__icon md-icon"></span>
 814         </label>
 815
 816       <a href="./" class="md-nav__link md-nav__link--active">
 817         Ajax
 818       </a>
 819
 820
 821 <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
 822
 823
 824
 825
 826
 827     <label class="md-nav__title" for="__toc">
 828       <span class="md-nav__icon md-icon"></span>
 829       Table of contents
 830     </label>
 831     <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
 832
 833         <li class="md-nav__item">
 834   <a href="#ajax-inside-modules" class="md-nav__link">
 835     Ajax inside Modules
 836   </a>
 837
 838     <nav class="md-nav" aria-label="Ajax inside Modules">
 839       <ul class="md-nav__list">
 840
 841           <li class="md-nav__item">
 842   <a href="#_ajaxsetup" class="md-nav__link">
 843     _ajaxSetup()
 844   </a>
 845
 846 </li>
 847
 848           <li class="md-nav__item">
 849   <a href="#request-settings" class="md-nav__link">
 850     Request Settings
 851   </a>
 852
 853     <nav class="md-nav" aria-label="Request Settings">
 854       <ul class="md-nav__list">
 855
 856           <li class="md-nav__item">
 857   <a href="#data" class="md-nav__link">
 858     data
 859   </a>
 860
 861 </li>
 862
 863           <li class="md-nav__item">
 864   <a href="#contenttype" class="md-nav__link">
 865     contentType
 866   </a>
 867
 868 </li>
 869
 870           <li class="md-nav__item">
 871   <a href="#responsetype" class="md-nav__link">
 872     responseType
 873   </a>
 874
 875 </li>
 876
 877           <li class="md-nav__item">
 878   <a href="#type" class="md-nav__link">
 879     type
 880   </a>
 881
 882 </li>
 883
 884           <li class="md-nav__item">
 885   <a href="#url" class="md-nav__link">
 886     url
 887   </a>
 888
 889 </li>
 890
 891           <li class="md-nav__item">
 892   <a href="#withcredentials" class="md-nav__link">
 893     withCredentials
 894   </a>
 895
 896 </li>
 897
 898           <li class="md-nav__item">
 899   <a href="#autoabort" class="md-nav__link">
 900     autoAbort
 901   </a>
 902
 903 </li>
 904
 905           <li class="md-nav__item">
 906   <a href="#ignoreerror" class="md-nav__link">
 907     ignoreError
 908   </a>
 909
 910 </li>
 911
 912           <li class="md-nav__item">
 913   <a href="#silent" class="md-nav__link">
 914     silent
 915   </a>
 916
 917 </li>
 918
 919           <li class="md-nav__item">
 920   <a href="#includerequestedwith" class="md-nav__link">
 921     includeRequestedWith
 922   </a>
 923
 924 </li>
 925
 926           <li class="md-nav__item">
 927   <a href="#failure" class="md-nav__link">
 928     failure
 929   </a>
 930
 931 </li>
 932
 933           <li class="md-nav__item">
 934   <a href="#finalize" class="md-nav__link">
 935     finalize
 936   </a>
 937
 938 </li>
 939
 940           <li class="md-nav__item">
 941   <a href="#success" class="md-nav__link">
 942     success
 943   </a>
 944
 945 </li>
 946
 947       </ul>
 948     </nav>
 949
 950 </li>
 951
 952           <li class="md-nav__item">
 953   <a href="#_ajaxsuccess" class="md-nav__link">
 954     _ajaxSuccess()
 955   </a>
 956
 957 </li>
 958
 959           <li class="md-nav__item">
 960   <a href="#_ajaxfailure" class="md-nav__link">
 961     _ajaxFailure()
 962   </a>
 963
 964 </li>
 965
 966       </ul>
 967     </nav>
 968
 969 </li>
 970
 971         <li class="md-nav__item">
 972   <a href="#single-requests-without-a-module" class="md-nav__link">
 973     Single Requests Without a Module
 974   </a>
 975
 976 </li>
 977
 978     </ul>
 979
 980 </nav>
 981
 982     </li>
 983
 984
 985
 986
 987
 988
 989
 990     <li class="md-nav__item">
 991       <a href="../new-api_dialogs/" class="md-nav__link">
 992         Dialogs
 993       </a>
 994     </li>
 995
 996
 997
 998
 999
1000
1001
1002     <li class="md-nav__item">
1003       <a href="../new-api_browser/" class="md-nav__link">
1004         Browser and Screen Sizes
1005       </a>
1006     </li>
1007
1008
1009
1010
1011
1012
1013
1014     <li class="md-nav__item">
1015       <a href="../new-api_ui/" class="md-nav__link">
1016         User Interface
1017       </a>
1018     </li>
1019
1020
1021
1022         </ul>
1023       </nav>
1024     </li>
1025
1026
1027
1028
1029
1030
1031
1032     <li class="md-nav__item">
1033       <a href="../legacy-api/" class="md-nav__link">
1034         Legacy API
1035       </a>
1036     </li>
1037
1038
1039
1040
1041
1042
1043
1044     <li class="md-nav__item">
1045       <a href="../helper-functions/" class="md-nav__link">
1046         Helper Functions
1047       </a>
1048     </li>
1049
1050
1051
1052
1053
1054
1055
1056     <li class="md-nav__item">
1057       <a href="../code-snippets/" class="md-nav__link">
1058         Code Snippets
1059       </a>
1060     </li>
1061
1062
1063
1064         </ul>
1065       </nav>
1066     </li>
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078     <li class="md-nav__item md-nav__item--nested">
1079
1080
1081         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5" type="checkbox" id="__nav_5" >
1082
1083       <label class="md-nav__link" for="__nav_5">
1084         Package Components
1085         <span class="md-nav__icon md-icon"></span>
1086       </label>
1087       <nav class="md-nav" aria-label="Package Components" data-md-level="1">
1088         <label class="md-nav__title" for="__nav_5">
1089           <span class="md-nav__icon md-icon"></span>
1090           Package Components
1091         </label>
1092         <ul class="md-nav__list" data-md-scrollfix>
1093
1094
1095
1096
1097
1098     <li class="md-nav__item">
1099       <a href="../../package/package-xml/" class="md-nav__link">
1100         package.xml
1101       </a>
1102     </li>
1103
1104
1105
1106
1107
1108
1109
1110
1111     <li class="md-nav__item md-nav__item--nested">
1112
1113
1114         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_2" type="checkbox" id="__nav_5_2" >
1115
1116       <label class="md-nav__link" for="__nav_5_2">
1117         PIPs
1118         <span class="md-nav__icon md-icon"></span>
1119       </label>
1120       <nav class="md-nav" aria-label="PIPs" data-md-level="2">
1121         <label class="md-nav__title" for="__nav_5_2">
1122           <span class="md-nav__icon md-icon"></span>
1123           PIPs
1124         </label>
1125         <ul class="md-nav__list" data-md-scrollfix>
1126
1127
1128
1129
1130
1131     <li class="md-nav__item">
1132       <a href="../../package/pip/" class="md-nav__link">
1133         Overview
1134       </a>
1135     </li>
1136
1137
1138
1139
1140
1141
1142
1143     <li class="md-nav__item">
1144       <a href="../../package/pip/acl-option/" class="md-nav__link">
1145         aclOption
1146       </a>
1147     </li>
1148
1149
1150
1151
1152
1153
1154
1155     <li class="md-nav__item">
1156       <a href="../../package/pip/acp-menu/" class="md-nav__link">
1157         acpMenu
1158       </a>
1159     </li>
1160
1161
1162
1163
1164
1165
1166
1167     <li class="md-nav__item">
1168       <a href="../../package/pip/acp-search-provider/" class="md-nav__link">
1169         acpSearchProvider
1170       </a>
1171     </li>
1172
1173
1174
1175
1176
1177
1178
1179     <li class="md-nav__item">
1180       <a href="../../package/pip/acp-template/" class="md-nav__link">
1181         acpTemplate
1182       </a>
1183     </li>
1184
1185
1186
1187
1188
1189
1190
1191     <li class="md-nav__item">
1192       <a href="../../package/pip/bbcode/" class="md-nav__link">
1193         bbcode
1194       </a>
1195     </li>
1196
1197
1198
1199
1200
1201
1202
1203     <li class="md-nav__item">
1204       <a href="../../package/pip/box/" class="md-nav__link">
1205         box
1206       </a>
1207     </li>
1208
1209
1210
1211
1212
1213
1214
1215     <li class="md-nav__item">
1216       <a href="../../package/pip/clipboard-action/" class="md-nav__link">
1217         clipboardAction
1218       </a>
1219     </li>
1220
1221
1222
1223
1224
1225
1226
1227     <li class="md-nav__item">
1228       <a href="../../package/pip/core-object/" class="md-nav__link">
1229         coreObject
1230       </a>
1231     </li>
1232
1233
1234
1235
1236
1237
1238
1239     <li class="md-nav__item">
1240       <a href="../../package/pip/cronjob/" class="md-nav__link">
1241         cronjob
1242       </a>
1243     </li>
1244
1245
1246
1247
1248
1249
1250
1251     <li class="md-nav__item">
1252       <a href="../../package/pip/database/" class="md-nav__link">
1253         database
1254       </a>
1255     </li>
1256
1257
1258
1259
1260
1261
1262
1263     <li class="md-nav__item">
1264       <a href="../../package/pip/event-listener/" class="md-nav__link">
1265         eventListener
1266       </a>
1267     </li>
1268
1269
1270
1271
1272
1273
1274
1275     <li class="md-nav__item">
1276       <a href="../../package/pip/file/" class="md-nav__link">
1277         file
1278       </a>
1279     </li>
1280
1281
1282
1283
1284
1285
1286
1287     <li class="md-nav__item">
1288       <a href="../../package/pip/language/" class="md-nav__link">
1289         language
1290       </a>
1291     </li>
1292
1293
1294
1295
1296
1297
1298
1299     <li class="md-nav__item">
1300       <a href="../../package/pip/media-provider/" class="md-nav__link">
1301         mediaProvider
1302       </a>
1303     </li>
1304
1305
1306
1307
1308
1309
1310
1311     <li class="md-nav__item">
1312       <a href="../../package/pip/menu/" class="md-nav__link">
1313         menu
1314       </a>
1315     </li>
1316
1317
1318
1319
1320
1321
1322
1323     <li class="md-nav__item">
1324       <a href="../../package/pip/menu-item/" class="md-nav__link">
1325         menuItem
1326       </a>
1327     </li>
1328
1329
1330
1331
1332
1333
1334
1335     <li class="md-nav__item">
1336       <a href="../../package/pip/object-type/" class="md-nav__link">
1337         objectType
1338       </a>
1339     </li>
1340
1341
1342
1343
1344
1345
1346
1347     <li class="md-nav__item">
1348       <a href="../../package/pip/object-type-definition/" class="md-nav__link">
1349         objectTypeDefinition
1350       </a>
1351     </li>
1352
1353
1354
1355
1356
1357
1358
1359     <li class="md-nav__item">
1360       <a href="../../package/pip/option/" class="md-nav__link">
1361         option
1362       </a>
1363     </li>
1364
1365
1366
1367
1368
1369
1370
1371     <li class="md-nav__item">
1372       <a href="../../package/pip/page/" class="md-nav__link">
1373         page
1374       </a>
1375     </li>
1376
1377
1378
1379
1380
1381
1382
1383     <li class="md-nav__item">
1384       <a href="../../package/pip/pip/" class="md-nav__link">
1385         pip
1386       </a>
1387     </li>
1388
1389
1390
1391
1392
1393
1394
1395     <li class="md-nav__item">
1396       <a href="../../package/pip/script/" class="md-nav__link">
1397         script
1398       </a>
1399     </li>
1400
1401
1402
1403
1404
1405
1406
1407     <li class="md-nav__item">
1408       <a href="../../package/pip/smiley/" class="md-nav__link">
1409         smiley
1410       </a>
1411     </li>
1412
1413
1414
1415
1416
1417
1418
1419     <li class="md-nav__item">
1420       <a href="../../package/pip/sql/" class="md-nav__link">
1421         sql
1422       </a>
1423     </li>
1424
1425
1426
1427
1428
1429
1430
1431     <li class="md-nav__item">
1432       <a href="../../package/pip/style/" class="md-nav__link">
1433         style
1434       </a>
1435     </li>
1436
1437
1438
1439
1440
1441
1442
1443     <li class="md-nav__item">
1444       <a href="../../package/pip/template/" class="md-nav__link">
1445         template
1446       </a>
1447     </li>
1448
1449
1450
1451
1452
1453
1454
1455     <li class="md-nav__item">
1456       <a href="../../package/pip/template-listener/" class="md-nav__link">
1457         templateListener
1458       </a>
1459     </li>
1460
1461
1462
1463
1464
1465
1466
1467     <li class="md-nav__item">
1468       <a href="../../package/pip/user-group-option/" class="md-nav__link">
1469         userGroupOption
1470       </a>
1471     </li>
1472
1473
1474
1475
1476
1477
1478
1479     <li class="md-nav__item">
1480       <a href="../../package/pip/user-menu/" class="md-nav__link">
1481         userMenu
1482       </a>
1483     </li>
1484
1485
1486
1487
1488
1489
1490
1491     <li class="md-nav__item">
1492       <a href="../../package/pip/user-notification-event/" class="md-nav__link">
1493         userNotificationEvent
1494       </a>
1495     </li>
1496
1497
1498
1499
1500
1501
1502
1503     <li class="md-nav__item">
1504       <a href="../../package/pip/user-option/" class="md-nav__link">
1505         userOption
1506       </a>
1507     </li>
1508
1509
1510
1511
1512
1513
1514
1515     <li class="md-nav__item">
1516       <a href="../../package/pip/user-profile-menu/" class="md-nav__link">
1517         userProfileMenu
1518       </a>
1519     </li>
1520
1521
1522
1523         </ul>
1524       </nav>
1525     </li>
1526
1527
1528
1529
1530
1531
1532
1533     <li class="md-nav__item">
1534       <a href="../../package/database-php-api/" class="md-nav__link">
1535         Database PHP API
1536       </a>
1537     </li>
1538
1539
1540
1541         </ul>
1542       </nav>
1543     </li>
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555     <li class="md-nav__item md-nav__item--nested">
1556
1557
1558         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6" type="checkbox" id="__nav_6" >
1559
1560       <label class="md-nav__link" for="__nav_6">
1561         Migration
1562         <span class="md-nav__icon md-icon"></span>
1563       </label>
1564       <nav class="md-nav" aria-label="Migration" data-md-level="1">
1565         <label class="md-nav__title" for="__nav_6">
1566           <span class="md-nav__icon md-icon"></span>
1567           Migration
1568         </label>
1569         <ul class="md-nav__list" data-md-scrollfix>
1570
1571
1572
1573
1574
1575
1576     <li class="md-nav__item md-nav__item--nested">
1577
1578
1579         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_1" type="checkbox" id="__nav_6_1" >
1580
1581       <label class="md-nav__link" for="__nav_6_1">
1582         Migrating from WSC 5.3
1583         <span class="md-nav__icon md-icon"></span>
1584       </label>
1585       <nav class="md-nav" aria-label="Migrating from WSC 5.3" data-md-level="2">
1586         <label class="md-nav__title" for="__nav_6_1">
1587           <span class="md-nav__icon md-icon"></span>
1588           Migrating from WSC 5.3
1589         </label>
1590         <ul class="md-nav__list" data-md-scrollfix>
1591
1592
1593
1594
1595
1596     <li class="md-nav__item">
1597       <a href="../../migration/wsc53/php/" class="md-nav__link">
1598         PHP API
1599       </a>
1600     </li>
1601
1602
1603
1604
1605
1606
1607
1608     <li class="md-nav__item">
1609       <a href="../../migration/wsc53/session/" class="md-nav__link">
1610         Session Handling and Authentication
1611       </a>
1612     </li>
1613
1614
1615
1616
1617
1618
1619
1620     <li class="md-nav__item">
1621       <a href="../../migration/wsc53/javascript/" class="md-nav__link">
1622         TypeScript and JavaScript
1623       </a>
1624     </li>
1625
1626
1627
1628
1629
1630
1631
1632     <li class="md-nav__item">
1633       <a href="../../migration/wsc53/templates/" class="md-nav__link">
1634         Templates
1635       </a>
1636     </li>
1637
1638
1639
1640
1641
1642
1643
1644     <li class="md-nav__item">
1645       <a href="../../migration/wsc53/libraries/" class="md-nav__link">
1646         Third Party Libraries
1647       </a>
1648     </li>
1649
1650
1651
1652         </ul>
1653       </nav>
1654     </li>
1655
1656
1657
1658
1659
1660
1661
1662
1663     <li class="md-nav__item md-nav__item--nested">
1664
1665
1666         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_2" type="checkbox" id="__nav_6_2" >
1667
1668       <label class="md-nav__link" for="__nav_6_2">
1669         Migrating from WSC 5.2
1670         <span class="md-nav__icon md-icon"></span>
1671       </label>
1672       <nav class="md-nav" aria-label="Migrating from WSC 5.2" data-md-level="2">
1673         <label class="md-nav__title" for="__nav_6_2">
1674           <span class="md-nav__icon md-icon"></span>
1675           Migrating from WSC 5.2
1676         </label>
1677         <ul class="md-nav__list" data-md-scrollfix>
1678
1679
1680
1681
1682
1683     <li class="md-nav__item">
1684       <a href="../../migration/wsc52/php/" class="md-nav__link">
1685         PHP API
1686       </a>
1687     </li>
1688
1689
1690
1691
1692
1693
1694
1695     <li class="md-nav__item">
1696       <a href="../../migration/wsc52/templates/" class="md-nav__link">
1697         Templates and Languages
1698       </a>
1699     </li>
1700
1701
1702
1703
1704
1705
1706
1707     <li class="md-nav__item">
1708       <a href="../../migration/wsc52/libraries/" class="md-nav__link">
1709         Third Party Libraries
1710       </a>
1711     </li>
1712
1713
1714
1715         </ul>
1716       </nav>
1717     </li>
1718
1719
1720
1721
1722
1723
1724
1725
1726     <li class="md-nav__item md-nav__item--nested">
1727
1728
1729         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_3" type="checkbox" id="__nav_6_3" >
1730
1731       <label class="md-nav__link" for="__nav_6_3">
1732         Migrating from WSC 3.1
1733         <span class="md-nav__icon md-icon"></span>
1734       </label>
1735       <nav class="md-nav" aria-label="Migrating from WSC 3.1" data-md-level="2">
1736         <label class="md-nav__title" for="__nav_6_3">
1737           <span class="md-nav__icon md-icon"></span>
1738           Migrating from WSC 3.1
1739         </label>
1740         <ul class="md-nav__list" data-md-scrollfix>
1741
1742
1743
1744
1745
1746     <li class="md-nav__item">
1747       <a href="../../migration/wsc31/php/" class="md-nav__link">
1748         PHP API
1749       </a>
1750     </li>
1751
1752
1753
1754         </ul>
1755       </nav>
1756     </li>
1757
1758
1759
1760
1761
1762
1763
1764
1765     <li class="md-nav__item md-nav__item--nested">
1766
1767
1768         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_4" type="checkbox" id="__nav_6_4" >
1769
1770       <label class="md-nav__link" for="__nav_6_4">
1771         Migrating from WSC 3.0
1772         <span class="md-nav__icon md-icon"></span>
1773       </label>
1774       <nav class="md-nav" aria-label="Migrating from WSC 3.0" data-md-level="2">
1775         <label class="md-nav__title" for="__nav_6_4">
1776           <span class="md-nav__icon md-icon"></span>
1777           Migrating from WSC 3.0
1778         </label>
1779         <ul class="md-nav__list" data-md-scrollfix>
1780
1781
1782
1783
1784
1785     <li class="md-nav__item">
1786       <a href="../../migration/wsc30/php/" class="md-nav__link">
1787         PHP API
1788       </a>
1789     </li>
1790
1791
1792
1793
1794
1795
1796
1797     <li class="md-nav__item">
1798       <a href="../../migration/wsc30/javascript/" class="md-nav__link">
1799         JavaScript API
1800       </a>
1801     </li>
1802
1803
1804
1805
1806
1807
1808
1809     <li class="md-nav__item">
1810       <a href="../../migration/wsc30/templates/" class="md-nav__link">
1811         Templates
1812       </a>
1813     </li>
1814
1815
1816
1817
1818
1819
1820
1821     <li class="md-nav__item">
1822       <a href="../../migration/wsc30/css/" class="md-nav__link">
1823         CSS
1824       </a>
1825     </li>
1826
1827
1828
1829
1830
1831
1832
1833     <li class="md-nav__item">
1834       <a href="../../migration/wsc30/package/" class="md-nav__link">
1835         Package Components
1836       </a>
1837     </li>
1838
1839
1840
1841         </ul>
1842       </nav>
1843     </li>
1844
1845
1846
1847
1848
1849
1850
1851
1852     <li class="md-nav__item md-nav__item--nested">
1853
1854
1855         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_5" type="checkbox" id="__nav_6_5" >
1856
1857       <label class="md-nav__link" for="__nav_6_5">
1858         Migrating from WCF 2.1
1859         <span class="md-nav__icon md-icon"></span>
1860       </label>
1861       <nav class="md-nav" aria-label="Migrating from WCF 2.1" data-md-level="2">
1862         <label class="md-nav__title" for="__nav_6_5">
1863           <span class="md-nav__icon md-icon"></span>
1864           Migrating from WCF 2.1
1865         </label>
1866         <ul class="md-nav__list" data-md-scrollfix>
1867
1868
1869
1870
1871
1872     <li class="md-nav__item">
1873       <a href="../../migration/wcf21/php/" class="md-nav__link">
1874         PHP API
1875       </a>
1876     </li>
1877
1878
1879
1880
1881
1882
1883
1884     <li class="md-nav__item">
1885       <a href="../../migration/wcf21/templates/" class="md-nav__link">
1886         Templates
1887       </a>
1888     </li>
1889
1890
1891
1892
1893
1894
1895
1896     <li class="md-nav__item">
1897       <a href="../../migration/wcf21/css/" class="md-nav__link">
1898         CSS
1899       </a>
1900     </li>
1901
1902
1903
1904
1905
1906
1907
1908     <li class="md-nav__item">
1909       <a href="../../migration/wcf21/package/" class="md-nav__link">
1910         Package Components
1911       </a>
1912     </li>
1913
1914
1915
1916         </ul>
1917       </nav>
1918     </li>
1919
1920
1921
1922         </ul>
1923       </nav>
1924     </li>
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936     <li class="md-nav__item md-nav__item--nested">
1937
1938
1939         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_7" type="checkbox" id="__nav_7" >
1940
1941       <label class="md-nav__link" for="__nav_7">
1942         Tutorials
1943         <span class="md-nav__icon md-icon"></span>
1944       </label>
1945       <nav class="md-nav" aria-label="Tutorials" data-md-level="1">
1946         <label class="md-nav__title" for="__nav_7">
1947           <span class="md-nav__icon md-icon"></span>
1948           Tutorials
1949         </label>
1950         <ul class="md-nav__list" data-md-scrollfix>
1951
1952
1953
1954
1955
1956
1957     <li class="md-nav__item md-nav__item--nested">
1958
1959
1960         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_7_1" type="checkbox" id="__nav_7_1" >
1961
1962       <label class="md-nav__link" for="__nav_7_1">
1963         Tutorial Series
1964         <span class="md-nav__icon md-icon"></span>
1965       </label>
1966       <nav class="md-nav" aria-label="Tutorial Series" data-md-level="2">
1967         <label class="md-nav__title" for="__nav_7_1">
1968           <span class="md-nav__icon md-icon"></span>
1969           Tutorial Series
1970         </label>
1971         <ul class="md-nav__list" data-md-scrollfix>
1972
1973
1974
1975
1976
1977     <li class="md-nav__item">
1978       <a href="../../tutorial/series/overview/" class="md-nav__link">
1979         Overview
1980       </a>
1981     </li>
1982
1983
1984
1985
1986
1987
1988
1989     <li class="md-nav__item">
1990       <a href="../../tutorial/series/part_1/" class="md-nav__link">
1991         Part 1
1992       </a>
1993     </li>
1994
1995
1996
1997
1998
1999
2000
2001     <li class="md-nav__item">
2002       <a href="../../tutorial/series/part_2/" class="md-nav__link">
2003         Part 2
2004       </a>
2005     </li>
2006
2007
2008
2009
2010
2011
2012
2013     <li class="md-nav__item">
2014       <a href="../../tutorial/series/part_3/" class="md-nav__link">
2015         Part 3
2016       </a>
2017     </li>
2018
2019
2020
2021         </ul>
2022       </nav>
2023     </li>
2024
2025
2026
2027         </ul>
2028       </nav>
2029     </li>
2030
2031
2032
2033   </ul>
2034 </nav>
2035                   </div>
2036                 </div>
2037               </div>
2038
2039
2040
2041               <div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
2042                 <div class="md-sidebar__scrollwrap">
2043                   <div class="md-sidebar__inner">
2044
2045 <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
2046
2047
2048
2049
2050
2051     <label class="md-nav__title" for="__toc">
2052       <span class="md-nav__icon md-icon"></span>
2053       Table of contents
2054     </label>
2055     <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
2056
2057         <li class="md-nav__item">
2058   <a href="#ajax-inside-modules" class="md-nav__link">
2059     Ajax inside Modules
2060   </a>
2061
2062     <nav class="md-nav" aria-label="Ajax inside Modules">
2063       <ul class="md-nav__list">
2064
2065           <li class="md-nav__item">
2066   <a href="#_ajaxsetup" class="md-nav__link">
2067     _ajaxSetup()
2068   </a>
2069
2070 </li>
2071
2072           <li class="md-nav__item">
2073   <a href="#request-settings" class="md-nav__link">
2074     Request Settings
2075   </a>
2076
2077     <nav class="md-nav" aria-label="Request Settings">
2078       <ul class="md-nav__list">
2079
2080           <li class="md-nav__item">
2081   <a href="#data" class="md-nav__link">
2082     data
2083   </a>
2084
2085 </li>
2086
2087           <li class="md-nav__item">
2088   <a href="#contenttype" class="md-nav__link">
2089     contentType
2090   </a>
2091
2092 </li>
2093
2094           <li class="md-nav__item">
2095   <a href="#responsetype" class="md-nav__link">
2096     responseType
2097   </a>
2098
2099 </li>
2100
2101           <li class="md-nav__item">
2102   <a href="#type" class="md-nav__link">
2103     type
2104   </a>
2105
2106 </li>
2107
2108           <li class="md-nav__item">
2109   <a href="#url" class="md-nav__link">
2110     url
2111   </a>
2112
2113 </li>
2114
2115           <li class="md-nav__item">
2116   <a href="#withcredentials" class="md-nav__link">
2117     withCredentials
2118   </a>
2119
2120 </li>
2121
2122           <li class="md-nav__item">
2123   <a href="#autoabort" class="md-nav__link">
2124     autoAbort
2125   </a>
2126
2127 </li>
2128
2129           <li class="md-nav__item">
2130   <a href="#ignoreerror" class="md-nav__link">
2131     ignoreError
2132   </a>
2133
2134 </li>
2135
2136           <li class="md-nav__item">
2137   <a href="#silent" class="md-nav__link">
2138     silent
2139   </a>
2140
2141 </li>
2142
2143           <li class="md-nav__item">
2144   <a href="#includerequestedwith" class="md-nav__link">
2145     includeRequestedWith
2146   </a>
2147
2148 </li>
2149
2150           <li class="md-nav__item">
2151   <a href="#failure" class="md-nav__link">
2152     failure
2153   </a>
2154
2155 </li>
2156
2157           <li class="md-nav__item">
2158   <a href="#finalize" class="md-nav__link">
2159     finalize
2160   </a>
2161
2162 </li>
2163
2164           <li class="md-nav__item">
2165   <a href="#success" class="md-nav__link">
2166     success
2167   </a>
2168
2169 </li>
2170
2171       </ul>
2172     </nav>
2173
2174 </li>
2175
2176           <li class="md-nav__item">
2177   <a href="#_ajaxsuccess" class="md-nav__link">
2178     _ajaxSuccess()
2179   </a>
2180
2181 </li>
2182
2183           <li class="md-nav__item">
2184   <a href="#_ajaxfailure" class="md-nav__link">
2185     _ajaxFailure()
2186   </a>
2187
2188 </li>
2189
2190       </ul>
2191     </nav>
2192
2193 </li>
2194
2195         <li class="md-nav__item">
2196   <a href="#single-requests-without-a-module" class="md-nav__link">
2197     Single Requests Without a Module
2198   </a>
2199
2200 </li>
2201
2202     </ul>
2203
2204 </nav>
2205                   </div>
2206                 </div>
2207               </div>
2208
2209
2210           <div class="md-content" data-md-component="content">
2211             <article class="md-content__inner md-typeset">
2212
2213
2214                   <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">
2215                     <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>
2216                   </a>
2217
2218
2219                 <h1 id="ajax-requests-javascript-api">Ajax Requests - JavaScript API<a class="headerlink" href="#ajax-requests-javascript-api" title="Permanent link">#</a></h1>
2220 <h2 id="ajax-inside-modules">Ajax inside Modules<a class="headerlink" href="#ajax-inside-modules" title="Permanent link">#</a></h2>
2221 <p>The Ajax component was designed to be used from inside modules where an object
2222 reference is used to delegate request callbacks. This is acomplished through
2223 a set of magic methods that are automatically called when the request is created
2224 or its state has changed.</p>
2225 <h3 id="_ajaxsetup"><code>_ajaxSetup()</code><a class="headerlink" href="#_ajaxsetup" title="Permanent link">#</a></h3>
2226 <p>The lazy initialization is performed upon the first invocation from the callee,
2227 using the magic <code>_ajaxSetup()</code> method to retrieve the basic configuration for
2228 this and any future requests.</p>
2229 <p>The data returned by <code>_ajaxSetup()</code> is cached and the data will be used to
2230 pre-populate the request data before sending it. The callee can overwrite any of
2231 these properties. It is intended to reduce the overhead when issuing request
2232 when these requests share the same properties, such as accessing the same endpoint.</p>
2233 <div class="highlight"><pre><span></span><code><span class="c1">// App/Foo.js</span>
2234 <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>
2235   <span class="s2">&quot;use strict&quot;</span><span class="p">;</span>
2236
2237   <span class="kd">function</span> <span class="nx">Foo</span><span class="p">()</span> <span class="p">{};</span>
2238   <span class="nx">Foo</span><span class="p">.</span><span class="nx">prototype</span> <span class="o">=</span> <span class="p">{</span>
2239     <span class="nx">one</span><span class="o">:</span> <span class="kd">function</span><span class="p">()</span> <span class="p">{</span>
2240       <span class="c1">// this will issue an ajax request with the parameter `value` set to `1`</span>
2241       <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>
2242     <span class="p">},</span>
2243
2244     <span class="nx">two</span><span class="o">:</span> <span class="kd">function</span><span class="p">()</span> <span class="p">{</span>
2245       <span class="c1">// this request is almost identical to the one issued with `.one()`, but</span>
2246       <span class="c1">// the value is now set to `2` for this invocation only.</span>
2247       <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>
2248         <span class="nx">parameters</span><span class="o">:</span> <span class="p">{</span>
2249           <span class="nx">value</span><span class="o">:</span> <span class="mf">2</span>
2250         <span class="p">}</span>
2251       <span class="p">});</span>
2252     <span class="p">},</span>
2253
2254     <span class="nx">_ajaxSetup</span><span class="o">:</span> <span class="kd">function</span><span class="p">()</span> <span class="p">{</span>
2255       <span class="k">return</span> <span class="p">{</span>
2256         <span class="nx">data</span><span class="o">:</span> <span class="p">{</span>
2257           <span class="nx">actionName</span><span class="o">:</span> <span class="s2">&quot;makeSnafucated&quot;</span><span class="p">,</span>
2258           <span class="nx">className</span><span class="o">:</span> <span class="s2">&quot;app\\data\\foo\\FooAction&quot;</span><span class="p">,</span>
2259           <span class="nx">parameters</span><span class="o">:</span> <span class="p">{</span>
2260             <span class="nx">value</span><span class="o">:</span> <span class="mf">1</span>
2261           <span class="p">}</span>
2262         <span class="p">}</span>
2263       <span class="p">}</span>
2264     <span class="p">}</span>
2265   <span class="p">};</span>
2266
2267   <span class="k">return</span> <span class="nx">Foo</span><span class="p">;</span>
2268 <span class="p">});</span>
2269 </code></pre></div>
2270 <h3 id="request-settings">Request Settings<a class="headerlink" href="#request-settings" title="Permanent link">#</a></h3>
2271 <p>The object returned by the aforementioned <code>_ajaxSetup()</code> callback can contain these
2272 values:</p>
2273 <h4 id="data"><code>data</code><a class="headerlink" href="#data" title="Permanent link">#</a></h4>
2274 <p><em>Defaults to <code>{}</code>.</em></p>
2275 <p>A plain JavaScript object that contains the request data that represents the form
2276 data of the request. The <code>parameters</code> key is recognized by the PHP Ajax API and
2277 becomes accessible through <code>$this-&gt;parameters</code>.</p>
2278 <h4 id="contenttype"><code>contentType</code><a class="headerlink" href="#contenttype" title="Permanent link">#</a></h4>
2279 <p><em>Defaults to <code>application/x-www-form-urlencoded; charset=UTF-8</code>.</em></p>
2280 <p>The request content type, sets the <code>Content-Type</code> HTTP header if it is not empty.</p>
2281 <h4 id="responsetype"><code>responseType</code><a class="headerlink" href="#responsetype" title="Permanent link">#</a></h4>
2282 <p><em>Defaults to <code>application/json</code>.</em></p>
2283 <p>The server must respond with the <code>Content-Type</code> HTTP header set to this value,
2284 otherwise the request will be treated as failed. Requests for <code>application/json</code>
2285 will have the return body attempted to be evaluated as JSON.</p>
2286 <p>Other content types will only be validated based on the HTTP header, but no
2287 additional transformation is performed. For example, setting the <code>responseType</code>
2288 to <code>application/xml</code> will check the HTTP header, but will not transform the
2289 <code>data</code> parameter, you'll still receive a string in <code>_ajaxSuccess</code>!</p>
2290 <h4 id="type"><code>type</code><a class="headerlink" href="#type" title="Permanent link">#</a></h4>
2291 <p><em>Defaults to <code>POST</code>.</em></p>
2292 <p>The HTTP Verb used for this request.</p>
2293 <h4 id="url"><code>url</code><a class="headerlink" href="#url" title="Permanent link">#</a></h4>
2294 <p><em>Defaults to an empty string.</em></p>
2295 <p>Manual override for the request endpoint, it will be automatically set to the
2296 Core API endpoint if left empty. If the Core API endpoint is used, the options
2297 <code>includeRequestedWith</code> and <code>withCredentials</code> will be force-set to true.</p>
2298 <h4 id="withcredentials"><code>withCredentials</code><a class="headerlink" href="#withcredentials" title="Permanent link">#</a></h4>
2299 <div class="admonition warning">
2300 <p class="admonition-title">Enabling this parameter for any domain other than the current will trigger a CORS preflight request.</p>
2301 </div>
2302 <p><em>Defaults to <code>false</code>.</em></p>
2303 <p>Include cookies with this requested, is always true when <code>url</code> is (implicitly)
2304 set to the Core API endpoint.</p>
2305 <h4 id="autoabort"><code>autoAbort</code><a class="headerlink" href="#autoabort" title="Permanent link">#</a></h4>
2306 <p><em>Defaults to <code>false</code>.</em></p>
2307 <p>When set to <code>true</code>, any pending responses to earlier requests will be silently
2308 discarded when issuing a new request. This only makes sense if the new request
2309 is meant to completely replace the result of the previous one, regardless of its
2310 reponse body.</p>
2311 <p>Typical use-cases include input field with suggestions, where possible values
2312 are requested from the server, but the input changed faster than the server was
2313 able to reply. In this particular case the client is not interested in the result
2314 for an earlier value, auto-aborting these requests avoids implementing this logic
2315 in the requesting code.</p>
2316 <h4 id="ignoreerror"><code>ignoreError</code><a class="headerlink" href="#ignoreerror" title="Permanent link">#</a></h4>
2317 <p><em>Defaults to <code>false</code>.</em></p>
2318 <p>Any failing request will invoke the <code>failure</code>-callback to check if an error
2319 message should be displayed. Enabling this option will suppress the general
2320 error overlay that reports a failed request.</p>
2321 <p>You can achieve the same result by returning <code>false</code> in the <code>failure</code>-callback.</p>
2322 <h4 id="silent"><code>silent</code><a class="headerlink" href="#silent" title="Permanent link">#</a></h4>
2323 <p><em>Defaults to <code>false</code>.</em></p>
2324 <p>Enabling this option will suppress the loading indicator overlay for this request,
2325 other non-"silent" requests will still trigger the loading indicator.</p>
2326 <h4 id="includerequestedwith"><code>includeRequestedWith</code><a class="headerlink" href="#includerequestedwith" title="Permanent link">#</a></h4>
2327 <div class="admonition warning">
2328 <p class="admonition-title">Enabling this parameter for any domain other than the current will trigger a CORS preflight request.</p>
2329 </div>
2330 <p><em>Defaults to <code>true</code>.</em></p>
2331 <p>Sets the custom HTTP header <code>X-Requested-With: XMLHttpRequest</code> for the request,
2332 it is automatically set to <code>true</code> when <code>url</code> is pointing at the WSC API endpoint.</p>
2333 <h4 id="failure"><code>failure</code><a class="headerlink" href="#failure" title="Permanent link">#</a></h4>
2334 <p><em>Defaults to <code>null</code>.</em></p>
2335 <p>Optional callback function that will be invoked for requests that have failed
2336 for one of these reasons:
2337  1. The request timed out.
2338  2. The HTTP status is not <code>2xx</code> or <code>304</code>.
2339  3. A <code>responseType</code> was set, but the response HTTP header <code>Content-Type</code> did not match the expected value.
2340  4. The <code>responseType</code> was set to <code>application/json</code>, but the response body was not valid JSON.</p>
2341 <p>The callback function receives the parameter <code>xhr</code> (the <code>XMLHttpRequest</code> object)
2342 and <code>options</code> (deep clone of the request parameters). If the callback returns
2343 <code>false</code>, the general error overlay for failed requests will be suppressed.</p>
2344 <p>There will be no error overlay if <code>ignoreError</code> is set to <code>true</code> or if the
2345 request failed while attempting to evaluate the response body as JSON.</p>
2346 <h4 id="finalize"><code>finalize</code><a class="headerlink" href="#finalize" title="Permanent link">#</a></h4>
2347 <p><em>Defaults to <code>null</code>.</em></p>
2348 <p>Optional callback function that will be invoked once the request has completed,
2349 regardless if it succeeded or failed. The only parameter it receives is
2350 <code>options</code> (the request parameters object), but it does not receive the request's
2351 <code>XMLHttpRequest</code>.</p>
2352 <h4 id="success"><code>success</code><a class="headerlink" href="#success" title="Permanent link">#</a></h4>
2353 <p><em>Defaults to <code>null</code>.</em></p>
2354 <p>This semi-optional callback function will always be set to <code>_ajaxSuccess()</code> when
2355 invoking <code>Ajax.api()</code>. It receives four parameters:
2356  1. <code>data</code> - The request's response body as a string, or a JavaScript object if
2357     <code>contentType</code> was set to <code>application/json</code>.
2358  2. <code>responseText</code> - The unmodified response body, it equals the value for <code>data</code>
2359     for non-JSON requests.
2360  3. <code>xhr</code> - The underlying <code>XMLHttpRequest</code> object.
2361  4. <code>requestData</code> - The request parameters that were supplied when the request
2362     was issued.</p>
2363 <h3 id="_ajaxsuccess"><code>_ajaxSuccess()</code><a class="headerlink" href="#_ajaxsuccess" title="Permanent link">#</a></h3>
2364 <p>This callback method is automatically called for successful AJAX requests, it
2365 receives four parameters, with the first one containing either the response body
2366 as a string, or a JavaScript object for JSON requests.</p>
2367 <h3 id="_ajaxfailure"><code>_ajaxFailure()</code><a class="headerlink" href="#_ajaxfailure" title="Permanent link">#</a></h3>
2368 <p>Optional callback function that is invoked for failed requests, it will be
2369 automatically called if the callee implements it, otherwise the global error
2370 handler will be executed.</p>
2371 <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>
2372 <p>The <code>Ajax.api()</code> method expects an object that is used to extract the request
2373 configuration as well as providing the callback functions when the request state
2374 changes.</p>
2375 <p>You can issue a simple Ajax request without object binding through <code>Ajax.apiOnce()</code>
2376 that will destroy the instance after the request was finalized. This method is
2377 significantly more expensive for repeated requests and does not offer deriving
2378 modules from altering the behavior. It is strongly  recommended to always use
2379 <code>Ajax.api()</code> for requests to the WSC API endpoint.</p>
2380 <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>
2381   <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>
2382     <span class="nx">Ajax</span><span class="p">.</span><span class="nx">apiOnce</span><span class="p">({</span>
2383       <span class="nx">data</span><span class="o">:</span> <span class="p">{</span>
2384         <span class="nx">actionName</span><span class="o">:</span> <span class="s2">&quot;makeSnafucated&quot;</span><span class="p">,</span>
2385         <span class="nx">className</span><span class="o">:</span> <span class="s2">&quot;app\\data\\foo\\FooAction&quot;</span><span class="p">,</span>
2386         <span class="nx">parameters</span><span class="o">:</span> <span class="p">{</span>
2387           <span class="nx">value</span><span class="o">:</span> <span class="mf">3</span>
2388         <span class="p">}</span>
2389       <span class="p">},</span>
2390       <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>
2391         <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>
2392       <span class="p">}</span>
2393     <span class="p">})</span>
2394   <span class="p">});</span>
2395 <span class="p">&lt;/</span><span class="nt">script</span><span class="p">&gt;</span>
2396 </code></pre></div>
2397
2398
2399
2400
2401 <hr>
2402 <div class="md-source-date">
2403   <small>
2404
2405       Last update: 2021-01-08
2406
2407   </small>
2408 </div>
2409
2410
2411
2412
2413
2414
2415
2416
2417             </article>
2418           </div>
2419         </div>
2420
2421       </main>
2422
2423
2424 <footer class="md-footer">
2425
2426     <nav class="md-footer__inner md-grid" aria-label="Footer">
2427
2428         <a href="../new-api_events/" class="md-footer__link md-footer__link--prev" rel="prev">
2429           <div class="md-footer__button md-icon">
2430             <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>
2431           </div>
2432           <div class="md-footer__title">
2433             <div class="md-ellipsis">
2434               <span class="md-footer__direction">
2435                 Previous
2436               </span>
2437               Event Handling
2438             </div>
2439           </div>
2440         </a>
2441
2442
2443         <a href="../new-api_dialogs/" class="md-footer__link md-footer__link--next" rel="next">
2444           <div class="md-footer__title">
2445             <div class="md-ellipsis">
2446               <span class="md-footer__direction">
2447                 Next
2448               </span>
2449               Dialogs
2450             </div>
2451           </div>
2452           <div class="md-footer__button md-icon">
2453             <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>
2454           </div>
2455         </a>
2456
2457     </nav>
2458
2459   <div class="md-footer-meta md-typeset">
2460     <div class="md-footer-meta__inner md-grid">
2461       <div class="md-footer-copyright">
2462
2463           <div class="md-footer-copyright__highlight">
2464             Copyright © 2020 WoltLab GmbH
2465           </div>
2466
2467         Made with
2468         <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
2469           Material for MkDocs
2470         </a>
2471
2472       </div>
2473       <div class="md-footer-copyright">
2474         <a href="https://www.woltlab.com/legal-notice/">Legal Notice</a>
2475         <a href="https://www.woltlab.com/privacy-policy/">Privacy Policy</a>
2476 </div>
2477     </div>
2478   </div>
2479 </footer>
2480
2481     </div>
2482     <div class="md-dialog" data-md-component="dialog">
2483       <div class="md-dialog__inner md-typeset"></div>
2484     </div>
2485     <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>
2486
2487
2488       <script src="../../assets/javascripts/bundle.d892486b.min.js"></script>
2489
2490
2491   </body>
2492 </html>