blob: 6cd2cc4fd5b7c620ad710745ac4106848503c756 [file] [log] [blame]
j1c53f822020-06-07 15:32:06 -07001<!DOCTYPE html>
2<html lang="en">
3<head>
4 <meta charset="utf-8">
5 <title>JSDoc: Namespace: dtpsLMS</title>
6
7 <script src="scripts/prettify/prettify.js"> </script>
8 <script src="scripts/prettify/lang-css.js"> </script>
9 <!--[if lt IE 9]>
10 <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
11 <![endif]-->
12 <link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
13 <link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
14</head>
15
16<body>
17
18<div id="main">
19
20 <h1 class="page-title">Namespace: dtpsLMS</h1>
21
22
23
24
25
26
27<section>
28
29<header>
30
31 <h2>dtpsLMS</h2>
32
33
34</header>
35
36<article>
37 <div class="container-overview">
38
39
40 <div class="description">Global DTPS LMS integration object. All LMS-related tasks, such as fetching data, are handled by this object. This is always loaded first. Please read the guide docs for instructions on implementing a custom LMS.</div>
41
42
43
44
45
46 <h5 class="subsection-title">Properties:</h5>
47
48
49
50<table class="props">
51 <thead>
52 <tr>
53
54 <th>Name</th>
55
56
57 <th>Type</th>
58
59
60 <th>Attributes</th>
61
62
63
64
65 <th class="last">Description</th>
66 </tr>
67 </thead>
68
69 <tbody>
70
71
72 <tr>
73
74 <td class="name"><code>name</code></td>
75
76
77 <td class="type">
78
79
80<span class="param-type">string</span>
81
82
83
84 </td>
85
86
87 <td class="attributes">
88
89
90
91 </td>
92
93
94
95
96 <td class="description last">Full LMS name</td>
97 </tr>
98
99
100
101 <tr>
102
103 <td class="name"><code>shortName</code></td>
104
105
106 <td class="type">
107
108
109<span class="param-type">string</span>
110
111
112
113 </td>
114
115
116 <td class="attributes">
117
118 &lt;optional><br>
119
120
121
122 </td>
123
124
125
126
127 <td class="description last">Short LMS name</td>
128 </tr>
129
130
131
132 <tr>
133
134 <td class="name"><code>legalName</code></td>
135
136
137 <td class="type">
138
139
140<span class="param-type">string</span>
141
142
143
144 </td>
145
146
147 <td class="attributes">
148
149
150
151 </td>
152
153
154
155
156 <td class="description last">Legal name (or names) to show in the "Welcome to Power+" disclaimer</td>
157 </tr>
158
159
160
161 <tr>
162
163 <td class="name"><code>description</code></td>
164
165
166 <td class="type">
167
168
169<span class="param-type">string</span>
170
171
172
173 </td>
174
175
176 <td class="attributes">
177
178 &lt;optional><br>
179
180
181
182 </td>
183
184
185
186
187 <td class="description last">A short description of the LMS integration provided</td>
188 </tr>
189
190
191
192 <tr>
193
194 <td class="name"><code>logo</code></td>
195
196
197 <td class="type">
198
199
200<span class="param-type">string</span>
201
202
203
204 </td>
205
206
207 <td class="attributes">
208
209
210
211 </td>
212
213
214
215
216 <td class="description last">LMS logo image URL</td>
217 </tr>
218
219
220
221 <tr>
222
223 <td class="name"><code>url</code></td>
224
225
226 <td class="type">
227
228
229<span class="param-type">string</span>
230
231
232
233 </td>
234
235
236 <td class="attributes">
237
238
239
240 </td>
241
242
243
244
245 <td class="description last">URL to the LMS' website</td>
246 </tr>
247
248
249
250 <tr>
251
252 <td class="name"><code>source</code></td>
253
254
255 <td class="type">
256
257
258<span class="param-type">string</span>
259
260
261
262 </td>
263
264
265 <td class="attributes">
266
267
268
269 </td>
270
271
272
273
274 <td class="description last">URL to the LMS integration's source code</td>
275 </tr>
276
277
278
279 <tr>
280
281 <td class="name"><code>institutionSpecific</code></td>
282
283
284 <td class="type">
285
286
287<span class="param-type">boolean</span>
288
289
290
291 </td>
292
293
294 <td class="attributes">
295
296 &lt;optional><br>
297
298
299
300 </td>
301
302
303
304
305 <td class="description last">True if the LMS is designed for a specific institution</td>
306 </tr>
307
308
309
310 <tr>
311
312 <td class="name"><code>preferRubricGrades</code></td>
313
314
315 <td class="type">
316
317
318<span class="param-type">boolean</span>
319
320
321
322 </td>
323
324
325 <td class="attributes">
326
327 &lt;optional><br>
328
329
330
331 </td>
332
333
334
335
336 <td class="description last">True if DTPS should prefer rubric grades for assignments</td>
337 </tr>
338
339
340
341 <tr>
342
343 <td class="name"><code>genericGradebook</code></td>
344
345
346 <td class="type">
347
348
349<span class="param-type">boolean</span>
350
351
352
353 </td>
354
355
356 <td class="attributes">
357
358 &lt;optional><br>
359
360
361
362 </td>
363
364
365
366
367 <td class="description last">True if DTPS should show the generic gradebook. Ignored if dtpsLMS.gradebook defined.</td>
368 </tr>
369
370
371 </tbody>
372</table>
373
374
375
376
377<dl class="details">
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404 <dt class="tag-source">Source:</dt>
405 <dd class="tag-source"><ul class="dummy"><li>
406 <a href="core.js.html">core.js</a>, <a href="core.js.html#line1350">line 1350</a>
407 </li></ul></dd>
408
409
410
411
412
413
414
415</dl>
416
417
418
419
420 </div>
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437 <h3 class="subsection-title">Methods</h3>
438
439
440
441
442
443
444
445 <h4 class="name" id=".calculateGrade"><span class="type-signature">(static) </span>calculateGrade<span class="signature">(course, assignments)</span><span class="type-signature"> &rarr; {undefined|object}</span></h4>
446
447
448
449
450
451
452<div class="description">
453 [OPTIONAL] Calculates class grades with a custom grade calculation formula. Used for unique grading systems.
454</div>
455
456
457
458
459
460
461
462
463
464 <h5>Parameters:</h5>
465
466
467<table class="params">
468 <thead>
469 <tr>
470
471 <th>Name</th>
472
473
474 <th>Type</th>
475
476
477
478
479
480 <th class="last">Description</th>
481 </tr>
482 </thead>
483
484 <tbody>
485
486
487 <tr>
488
489 <td class="name"><code>course</code></td>
490
491
492 <td class="type">
493
494
495<span class="param-type"><a href="global.html#Class">Class</a></span>
496
497
498
499 </td>
500
501
502
503
504
505 <td class="description last">Class to calculate grades for [DO NOT USE COURSE.ASSIGNMENTS to access assignments for grade calculation. Use the assignments parameter instead.]</td>
506 </tr>
507
508
509
510 <tr>
511
512 <td class="name"><code>assignments</code></td>
513
514
515 <td class="type">
516
517
518<span class="param-type">Array.&lt;<a href="global.html#Assignment">Assignment</a>></span>
519
520
521
522 </td>
523
524
525
526
527
528 <td class="description last">Assignments used for grade calculation. Use this instead of course.assignments for hypothetical/what-if grade calculation.</td>
529 </tr>
530
531
532 </tbody>
533</table>
534
535
536
537
538
539
540<dl class="details">
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567 <dt class="tag-source">Source:</dt>
568 <dd class="tag-source"><ul class="dummy"><li>
569 <a href="core.js.html">core.js</a>, <a href="core.js.html#line1430">line 1430</a>
570 </li></ul></dd>
571
572
573
574
575
576
577
578</dl>
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594<h5>Returns:</h5>
595
596
597<div class="param-desc">
598 The letter grade should be returned in the "letter" property as a string and the percentage in the "grade" property as a number. Other custom properties can be set if they need to be accessed by dtpsLMS.gradebook. Return undefined if there is no grade for the class.
599</div>
600
601
602
603<dl>
604 <dt>
605 Type
606 </dt>
607 <dd>
608
609<span class="param-type">undefined</span>
610|
611
612<span class="param-type">object</span>
613
614
615 </dd>
616</dl>
617
618
619
620
621
622
623
624
625
626
627
628
629
630 <h4 class="name" id=".fetchAssignments"><span class="type-signature">(static) </span>fetchAssignments<span class="signature">(classID)</span><span class="type-signature"> &rarr; {Promise.&lt;Array.&lt;<a href="global.html#Assignment">Assignment</a>>>}</span></h4>
631
632
633
634
635
636
637<div class="description">
638 [REQUIRED] Fetches assignment data for a course from the LMS
639</div>
640
641
642
643
644
645
646
647
648
649 <h5>Parameters:</h5>
650
651
652<table class="params">
653 <thead>
654 <tr>
655
656 <th>Name</th>
657
658
659 <th>Type</th>
660
661
662
663
664
665 <th class="last">Description</th>
666 </tr>
667 </thead>
668
669 <tbody>
670
671
672 <tr>
673
674 <td class="name"><code>classID</code></td>
675
676
677 <td class="type">
678
679
680<span class="param-type">string</span>
681
682
683
684 </td>
685
686
687
688
689
690 <td class="description last">The class ID to fetch assignments for</td>
691 </tr>
692
693
694 </tbody>
695</table>
696
697
698
699
700
701
702<dl class="details">
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729 <dt class="tag-source">Source:</dt>
730 <dd class="tag-source"><ul class="dummy"><li>
731 <a href="core.js.html">core.js</a>, <a href="core.js.html#line1380">line 1380</a>
732 </li></ul></dd>
733
734
735
736
737
738
739
740</dl>
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756<h5>Returns:</h5>
757
758
759<div class="param-desc">
760 A promise which resolves to an array of Assignment objects
761</div>
762
763
764
765<dl>
766 <dt>
767 Type
768 </dt>
769 <dd>
770
771<span class="param-type">Promise.&lt;Array.&lt;<a href="global.html#Assignment">Assignment</a>>></span>
772
773
774 </dd>
775</dl>
776
777
778
779
780
781
782
783
784
785
786
787
788
789 <h4 class="name" id=".fetchClasses"><span class="type-signature">(static) </span>fetchClasses<span class="signature">()</span><span class="type-signature"> &rarr; {Promise.&lt;Array.&lt;<a href="global.html#Class">Class</a>>>}</span></h4>
790
791
792
793
794
795
796<div class="description">
797 [REQUIRED] Fetches class data from the LMS
798</div>
799
800
801
802
803
804
805
806
807
808
809
810
811
812<dl class="details">
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839 <dt class="tag-source">Source:</dt>
840 <dd class="tag-source"><ul class="dummy"><li>
841 <a href="core.js.html">core.js</a>, <a href="core.js.html#line1373">line 1373</a>
842 </li></ul></dd>
843
844
845
846
847
848
849
850</dl>
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866<h5>Returns:</h5>
867
868
869<div class="param-desc">
870 A promise which resolves to an array of Class objects
871</div>
872
873
874
875<dl>
876 <dt>
877 Type
878 </dt>
879 <dd>
880
881<span class="param-type">Promise.&lt;Array.&lt;<a href="global.html#Class">Class</a>>></span>
882
883
884 </dd>
885</dl>
886
887
888
889
890
891
892
893
894
895
896
897
898
899 <h4 class="name" id=".fetchDiscussionPosts"><span class="type-signature">(static) </span>fetchDiscussionPosts<span class="signature">(classID, threadID)</span><span class="type-signature"> &rarr; {Promise.&lt;Array.&lt;<a href="global.html#DiscussionPost">DiscussionPost</a>>>}</span></h4>
900
901
902
903
904
905
906<div class="description">
907 [REQUIRED IF dtpsLMS.fetchDiscussionThreads IS IMPLEMENTED] Fetches discussion posts in a thread from the LMS
908</div>
909
910
911
912
913
914
915
916
917
918 <h5>Parameters:</h5>
919
920
921<table class="params">
922 <thead>
923 <tr>
924
925 <th>Name</th>
926
927
928 <th>Type</th>
929
930
931
932
933
934 <th class="last">Description</th>
935 </tr>
936 </thead>
937
938 <tbody>
939
940
941 <tr>
942
943 <td class="name"><code>classID</code></td>
944
945
946 <td class="type">
947
948
949<span class="param-type">string</span>
950
951
952
953 </td>
954
955
956
957
958
959 <td class="description last">The class ID to fetch discussion posts for</td>
960 </tr>
961
962
963
964 <tr>
965
966 <td class="name"><code>threadID</code></td>
967
968
969 <td class="type">
970
971
972<span class="param-type">string</span>
973
974
975
976 </td>
977
978
979
980
981
982 <td class="description last">The discussion thread ID to fetch discussion posts for</td>
983 </tr>
984
985
986 </tbody>
987</table>
988
989
990
991
992
993
994<dl class="details">
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021 <dt class="tag-source">Source:</dt>
1022 <dd class="tag-source"><ul class="dummy"><li>
1023 <a href="core.js.html">core.js</a>, <a href="core.js.html#line1396">line 1396</a>
1024 </li></ul></dd>
1025
1026
1027
1028
1029
1030
1031
1032</dl>
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048<h5>Returns:</h5>
1049
1050
1051<div class="param-desc">
1052 A promise which resolves to an array of Discussion Post objects
1053</div>
1054
1055
1056
1057<dl>
1058 <dt>
1059 Type
1060 </dt>
1061 <dd>
1062
1063<span class="param-type">Promise.&lt;Array.&lt;<a href="global.html#DiscussionPost">DiscussionPost</a>>></span>
1064
1065
1066 </dd>
1067</dl>
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081 <h4 class="name" id=".fetchDiscussionThreads"><span class="type-signature">(static) </span>fetchDiscussionThreads<span class="signature">(classID)</span><span class="type-signature"> &rarr; {Promise.&lt;Array.&lt;<a href="global.html#DiscussionThread">DiscussionThread</a>>>}</span></h4>
1082
1083
1084
1085
1086
1087
1088<div class="description">
1089 [OPTIONAL] Fetches discussion threads for a course from the LMS
1090</div>
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100 <h5>Parameters:</h5>
1101
1102
1103<table class="params">
1104 <thead>
1105 <tr>
1106
1107 <th>Name</th>
1108
1109
1110 <th>Type</th>
1111
1112
1113
1114
1115
1116 <th class="last">Description</th>
1117 </tr>
1118 </thead>
1119
1120 <tbody>
1121
1122
1123 <tr>
1124
1125 <td class="name"><code>classID</code></td>
1126
1127
1128 <td class="type">
1129
1130
1131<span class="param-type">string</span>
1132
1133
1134
1135 </td>
1136
1137
1138
1139
1140
1141 <td class="description last">The class ID to fetch discussion threads for</td>
1142 </tr>
1143
1144
1145 </tbody>
1146</table>
1147
1148
1149
1150
1151
1152
1153<dl class="details">
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180 <dt class="tag-source">Source:</dt>
1181 <dd class="tag-source"><ul class="dummy"><li>
1182 <a href="core.js.html">core.js</a>, <a href="core.js.html#line1388">line 1388</a>
1183 </li></ul></dd>
1184
1185
1186
1187
1188
1189
1190
1191</dl>
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207<h5>Returns:</h5>
1208
1209
1210<div class="param-desc">
1211 A promise which resolves to an array of Discussion Thread objects
1212</div>
1213
1214
1215
1216<dl>
1217 <dt>
1218 Type
1219 </dt>
1220 <dd>
1221
1222<span class="param-type">Promise.&lt;Array.&lt;<a href="global.html#DiscussionThread">DiscussionThread</a>>></span>
1223
1224
1225 </dd>
1226</dl>
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240 <h4 class="name" id=".fetchPageContent"><span class="type-signature">(static) </span>fetchPageContent<span class="signature">(classID, pageID)</span><span class="type-signature"> &rarr; {Promise.&lt;string>}</span></h4>
1241
1242
1243
1244
1245
1246
1247<div class="description">
1248 [REQUIRED IF dtpsLMS.fetchPages IS IMPLEMENTED] Fetches content for a page from the LMS
1249</div>
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259 <h5>Parameters:</h5>
1260
1261
1262<table class="params">
1263 <thead>
1264 <tr>
1265
1266 <th>Name</th>
1267
1268
1269 <th>Type</th>
1270
1271
1272
1273
1274
1275 <th class="last">Description</th>
1276 </tr>
1277 </thead>
1278
1279 <tbody>
1280
1281
1282 <tr>
1283
1284 <td class="name"><code>classID</code></td>
1285
1286
1287 <td class="type">
1288
1289
1290<span class="param-type">string</span>
1291
1292
1293
1294 </td>
1295
1296
1297
1298
1299
1300 <td class="description last">The class ID to fetch page content for</td>
1301 </tr>
1302
1303
1304
1305 <tr>
1306
1307 <td class="name"><code>pageID</code></td>
1308
1309
1310 <td class="type">
1311
1312
1313<span class="param-type">string</span>
1314
1315
1316
1317 </td>
1318
1319
1320
1321
1322
1323 <td class="description last">The page ID to fetch page content for</td>
1324 </tr>
1325
1326
1327 </tbody>
1328</table>
1329
1330
1331
1332
1333
1334
1335<dl class="details">
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362 <dt class="tag-source">Source:</dt>
1363 <dd class="tag-source"><ul class="dummy"><li>
1364 <a href="core.js.html">core.js</a>, <a href="core.js.html#line1413">line 1413</a>
1365 </li></ul></dd>
1366
1367
1368
1369
1370
1371
1372
1373</dl>
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389<h5>Returns:</h5>
1390
1391
1392<div class="param-desc">
1393 A promise which resolves to the page's content as HTML
1394</div>
1395
1396
1397
1398<dl>
1399 <dt>
1400 Type
1401 </dt>
1402 <dd>
1403
1404<span class="param-type">Promise.&lt;string></span>
1405
1406
1407 </dd>
1408</dl>
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422 <h4 class="name" id=".fetchPages"><span class="type-signature">(static) </span>fetchPages<span class="signature">(classID)</span><span class="type-signature"> &rarr; {Promise.&lt;Array.&lt;<a href="global.html#Page">Page</a>>>}</span></h4>
1423
1424
1425
1426
1427
1428
1429<div class="description">
1430 [OPTIONAL] Fetches pages for a course from the LMS
1431</div>
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441 <h5>Parameters:</h5>
1442
1443
1444<table class="params">
1445 <thead>
1446 <tr>
1447
1448 <th>Name</th>
1449
1450
1451 <th>Type</th>
1452
1453
1454
1455
1456
1457 <th class="last">Description</th>
1458 </tr>
1459 </thead>
1460
1461 <tbody>
1462
1463
1464 <tr>
1465
1466 <td class="name"><code>classID</code></td>
1467
1468
1469 <td class="type">
1470
1471
1472<span class="param-type">string</span>
1473
1474
1475
1476 </td>
1477
1478
1479
1480
1481
1482 <td class="description last">The class ID to fetch pages for</td>
1483 </tr>
1484
1485
1486 </tbody>
1487</table>
1488
1489
1490
1491
1492
1493
1494<dl class="details">
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521 <dt class="tag-source">Source:</dt>
1522 <dd class="tag-source"><ul class="dummy"><li>
1523 <a href="core.js.html">core.js</a>, <a href="core.js.html#line1405">line 1405</a>
1524 </li></ul></dd>
1525
1526
1527
1528
1529
1530
1531
1532</dl>
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548<h5>Returns:</h5>
1549
1550
1551<div class="param-desc">
1552 A promise which resolves to an array of Page objects
1553</div>
1554
1555
1556
1557<dl>
1558 <dt>
1559 Type
1560 </dt>
1561 <dd>
1562
1563<span class="param-type">Promise.&lt;Array.&lt;<a href="global.html#Page">Page</a>>></span>
1564
1565
1566 </dd>
1567</dl>
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581 <h4 class="name" id=".fetchUser"><span class="type-signature">(static) </span>fetchUser<span class="signature">()</span><span class="type-signature"> &rarr; {Promise.&lt;<a href="global.html#User">User</a>>}</span></h4>
1582
1583
1584
1585
1586
1587
1588<div class="description">
1589 [REQUIRED] Fetches user data from the LMS
1590</div>
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604<dl class="details">
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631 <dt class="tag-source">Source:</dt>
1632 <dd class="tag-source"><ul class="dummy"><li>
1633 <a href="core.js.html">core.js</a>, <a href="core.js.html#line1366">line 1366</a>
1634 </li></ul></dd>
1635
1636
1637
1638
1639
1640
1641
1642</dl>
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658<h5>Returns:</h5>
1659
1660
1661<div class="param-desc">
1662 A promise which resolves to a User object
1663</div>
1664
1665
1666
1667<dl>
1668 <dt>
1669 Type
1670 </dt>
1671 <dd>
1672
1673<span class="param-type">Promise.&lt;<a href="global.html#User">User</a>></span>
1674
1675
1676 </dd>
1677</dl>
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691 <h4 class="name" id=".gradebook"><span class="type-signature">(static) </span>gradebook<span class="signature">(course)</span><span class="type-signature"> &rarr; {Promise.&lt;string>}</span></h4>
1692
1693
1694
1695
1696
1697
1698<div class="description">
1699 [OPTIONAL] Renders custom gradebook HTML for unique grading systems or for a more tailored experience. The gradebook only shows for classes with a grade and with at least 1 assignment.
1700</div>
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710 <h5>Parameters:</h5>
1711
1712
1713<table class="params">
1714 <thead>
1715 <tr>
1716
1717 <th>Name</th>
1718
1719
1720 <th>Type</th>
1721
1722
1723
1724
1725
1726 <th class="last">Description</th>
1727 </tr>
1728 </thead>
1729
1730 <tbody>
1731
1732
1733 <tr>
1734
1735 <td class="name"><code>course</code></td>
1736
1737
1738 <td class="type">
1739
1740
1741<span class="param-type"><a href="global.html#Class">Class</a></span>
1742
1743
1744
1745 </td>
1746
1747
1748
1749
1750
1751 <td class="description last">Class to render the gradebook for. If custom grade calculation is enabled (dtpsLMS.calculateGrade), those results can be accessed at course.gradeCalculation.</td>
1752 </tr>
1753
1754
1755 </tbody>
1756</table>
1757
1758
1759
1760
1761
1762
1763<dl class="details">
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790 <dt class="tag-source">Source:</dt>
1791 <dd class="tag-source"><ul class="dummy"><li>
1792 <a href="core.js.html">core.js</a>, <a href="core.js.html#line1422">line 1422</a>
1793 </li></ul></dd>
1794
1795
1796
1797
1798
1799
1800
1801</dl>
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817<h5>Returns:</h5>
1818
1819
1820<div class="param-desc">
1821 A promise which resolves to HTML to render for the class gradebook
1822</div>
1823
1824
1825
1826<dl>
1827 <dt>
1828 Type
1829 </dt>
1830 <dd>
1831
1832<span class="param-type">Promise.&lt;string></span>
1833
1834
1835 </dd>
1836</dl>
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850 <h4 class="name" id=".updateAssignments"><span class="type-signature">(static) </span>updateAssignments<span class="signature">(assignments)</span><span class="type-signature"> &rarr; {Array.&lt;<a href="global.html#Assignment">Assignment</a>>}</span></h4>
1851
1852
1853
1854
1855
1856
1857<div class="description">
1858 [OPTIONAL, INSTITUTION ONLY] This function can be implemented by institution-specific scripts to loop through and override assignment data returned by the LMS.
1859</div>
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869 <h5>Parameters:</h5>
1870
1871
1872<table class="params">
1873 <thead>
1874 <tr>
1875
1876 <th>Name</th>
1877
1878
1879 <th>Type</th>
1880
1881
1882
1883
1884
1885 <th class="last">Description</th>
1886 </tr>
1887 </thead>
1888
1889 <tbody>
1890
1891
1892 <tr>
1893
1894 <td class="name"><code>assignments</code></td>
1895
1896
1897 <td class="type">
1898
1899
1900<span class="param-type">Array.&lt;<a href="global.html#Assignment">Assignment</a>></span>
1901
1902
1903
1904 </td>
1905
1906
1907
1908
1909
1910 <td class="description last">Original assignments array</td>
1911 </tr>
1912
1913
1914 </tbody>
1915</table>
1916
1917
1918
1919
1920
1921
1922<dl class="details">
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949 <dt class="tag-source">Source:</dt>
1950 <dd class="tag-source"><ul class="dummy"><li>
1951 <a href="core.js.html">core.js</a>, <a href="core.js.html#line1439">line 1439</a>
1952 </li></ul></dd>
1953
1954
1955
1956
1957
1958
1959
1960</dl>
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976<h5>Returns:</h5>
1977
1978
1979<div class="param-desc">
1980 Updated assignments array
1981</div>
1982
1983
1984
1985<dl>
1986 <dt>
1987 Type
1988 </dt>
1989 <dd>
1990
1991<span class="param-type">Array.&lt;<a href="global.html#Assignment">Assignment</a>></span>
1992
1993
1994 </dd>
1995</dl>
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009 <h4 class="name" id=".updateClasses"><span class="type-signature">(static) </span>updateClasses<span class="signature">(classes)</span><span class="type-signature"> &rarr; {Array.&lt;<a href="global.html#Class">Class</a>>}</span></h4>
2010
2011
2012
2013
2014
2015
2016<div class="description">
2017 [OPTIONAL, INSTITUTION ONLY] This function can be implemented by institution-specific scripts to loop through and override class data returned by the LMS.
2018</div>
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028 <h5>Parameters:</h5>
2029
2030
2031<table class="params">
2032 <thead>
2033 <tr>
2034
2035 <th>Name</th>
2036
2037
2038 <th>Type</th>
2039
2040
2041
2042
2043
2044 <th class="last">Description</th>
2045 </tr>
2046 </thead>
2047
2048 <tbody>
2049
2050
2051 <tr>
2052
2053 <td class="name"><code>classes</code></td>
2054
2055
2056 <td class="type">
2057
2058
2059<span class="param-type">Array.&lt;<a href="global.html#Class">Class</a>></span>
2060
2061
2062
2063 </td>
2064
2065
2066
2067
2068
2069 <td class="description last">Original classes array</td>
2070 </tr>
2071
2072
2073 </tbody>
2074</table>
2075
2076
2077
2078
2079
2080
2081<dl class="details">
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108 <dt class="tag-source">Source:</dt>
2109 <dd class="tag-source"><ul class="dummy"><li>
2110 <a href="core.js.html">core.js</a>, <a href="core.js.html#line1447">line 1447</a>
2111 </li></ul></dd>
2112
2113
2114
2115
2116
2117
2118
2119</dl>
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135<h5>Returns:</h5>
2136
2137
2138<div class="param-desc">
2139 Updated classes array
2140</div>
2141
2142
2143
2144<dl>
2145 <dt>
2146 Type
2147 </dt>
2148 <dd>
2149
2150<span class="param-type">Array.&lt;<a href="global.html#Class">Class</a>></span>
2151
2152
2153 </dd>
2154</dl>
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168</article>
2169
2170</section>
2171
2172
2173
2174
2175</div>
2176
2177<nav>
2178 <h2><a href="index.html">Home</a></h2><h3>Namespaces</h3><ul><li><a href="dtps.html">dtps</a></li><li><a href="dtpsLMS.html">dtpsLMS</a></li></ul><h3><a href="global.html">Global</a></h3>
2179</nav>
2180
2181<br class="clear">
2182
2183<footer>
2184 Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.4</a> on Sun Jun 07 2020 14:02:58 GMT-0700 (Pacific Daylight Time)
2185</footer>
2186
2187<script> prettyPrint(); </script>
2188<script src="scripts/linenumber.js"> </script>
2189</body>
2190</html>