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