blob: a53c20192c71ee7778c3c15269088b49a2e343d0 [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: Global</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">Global</h1>
21
22
23
24
25
26
27<section>
28
29<header>
30
31 <h2></h2>
32
33
34</header>
35
36<article>
37 <div class="container-overview">
38
39
40
41
42
43
44<dl class="details">
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77</dl>
78
79
80
81
82 </div>
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101 <h3 class="subsection-title">Type Definitions</h3>
102
103
104
j35a697e2020-07-24 20:28:00 -0700105<h4 class="name" id="Announcement">Announcement</h4>
106
107
108
109
110<div class="description">
111 Defines announcement objects in DTPS
112</div>
113
114
115
116 <h5>Type:</h5>
117 <ul>
118 <li>
119
120<span class="param-type">Object</span>
121
122
123 </li>
124 </ul>
125
126
127
128
129
130 <h5 class="subsection-title">Properties:</h5>
131
132
133
134<table class="props">
135 <thead>
136 <tr>
137
138 <th>Name</th>
139
140
141 <th>Type</th>
142
143
144
145
146
147 <th class="last">Description</th>
148 </tr>
149 </thead>
150
151 <tbody>
152
153
154 <tr>
155
156 <td class="name"><code>title</code></td>
157
158
159 <td class="type">
160
161
162<span class="param-type">string</span>
163
164
165
166 </td>
167
168
169
170
171
172 <td class="description last">Title of the announcement</td>
173 </tr>
174
175
176
177 <tr>
178
179 <td class="name"><code>postedAt</code></td>
180
181
182 <td class="type">
183
184
185<span class="param-type"><a href="global.html#Date">Date</a></span>
186
187
188
189 </td>
190
191
192
193
194
195 <td class="description last">Date when the announcement was posted</td>
196 </tr>
197
198
199
200 <tr>
201
202 <td class="name"><code>body</code></td>
203
204
205 <td class="type">
206
207
208<span class="param-type">string</span>
209
210
211
212 </td>
213
214
215
216
217
218 <td class="description last">Announcement content</td>
219 </tr>
220
221
222 </tbody>
223</table>
224
225
226
227
228<dl class="details">
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255 <dt class="tag-source">Source:</dt>
256 <dd class="tag-source"><ul class="dummy"><li>
257 <a href="assignments.js.html">assignments.js</a>, <a href="assignments.js.html#line1024">line 1024</a>
258 </li></ul></dd>
259
260
261
262
263
264
265
266</dl>
267
268
269
270
271
272
273
274
j1c53f822020-06-07 15:32:06 -0700275<h4 class="name" id="Assignment">Assignment</h4>
276
277
278
279
280<div class="description">
281 Defines assignments objects in DTPS
282</div>
283
284
285
286 <h5>Type:</h5>
287 <ul>
288 <li>
289
290<span class="param-type">Object</span>
291
292
293 </li>
294 </ul>
295
296
297
298
299
300 <h5 class="subsection-title">Properties:</h5>
301
302
303
304<table class="props">
305 <thead>
306 <tr>
307
308 <th>Name</th>
309
310
311 <th>Type</th>
312
313
314 <th>Attributes</th>
315
316
317
318
319 <th class="last">Description</th>
320 </tr>
321 </thead>
322
323 <tbody>
324
325
326 <tr>
327
328 <td class="name"><code>title</code></td>
329
330
331 <td class="type">
332
333
334<span class="param-type">string</span>
335
336
337
338 </td>
339
340
341 <td class="attributes">
342
343
344
345 </td>
346
347
348
349
350 <td class="description last">Title of the assignment</td>
351 </tr>
352
353
354
355 <tr>
356
357 <td class="name"><code>body</code></td>
358
359
360 <td class="type">
361
362
363<span class="param-type">string</span>
364
365
366
367 </td>
368
369
370 <td class="attributes">
371
372 &lt;optional><br>
373
374
375
376 </td>
377
378
379
380
381 <td class="description last">HTML of the assignment's body</td>
382 </tr>
383
384
385
386 <tr>
387
388 <td class="name"><code>id</code></td>
389
390
391 <td class="type">
392
393
394<span class="param-type">string</span>
395
396
397
398 </td>
399
400
401 <td class="attributes">
402
403
404
405 </td>
406
407
408
409
410 <td class="description last">Assignment ID</td>
411 </tr>
412
413
414
415 <tr>
416
417 <td class="name"><code>dueAt</code></td>
418
419
420 <td class="type">
421
422
423<span class="param-type"><a href="global.html#Date">Date</a></span>
424
425
426
427 </td>
428
429
430 <td class="attributes">
431
432 &lt;optional><br>
433
434
435
436 </td>
437
438
439
440
441 <td class="description last">Assignment due date</td>
442 </tr>
443
444
445
446 <tr>
447
448 <td class="name"><code>url</code></td>
449
450
451 <td class="type">
452
453
454<span class="param-type">string</span>
455
456
457
458 </td>
459
460
461 <td class="attributes">
462
463
464
465 </td>
466
467
468
469
470 <td class="description last">Assignment URL</td>
471 </tr>
472
473
474
475 <tr>
476
477 <td class="name"><code>feedback</code></td>
478
479
480 <td class="type">
481
482
483<span class="param-type">Array.&lt;<a href="global.html#AssignmentFeedback">AssignmentFeedback</a>></span>
484
485
486
487 </td>
488
489
490 <td class="attributes">
491
492 &lt;optional><br>
493
494
495
496 </td>
497
498
499
500
501 <td class="description last">Feedback / private comments for this assignment</td>
502 </tr>
503
504
505
506 <tr>
507
508 <td class="name"><code>grader</code></td>
509
510
511 <td class="type">
512
513
514<span class="param-type"><a href="global.html#User">User</a></span>
515
516
517
518 </td>
519
520
521 <td class="attributes">
522
523 &lt;optional><br>
524
525
526
527 </td>
528
529
530
531
532 <td class="description last">Assignment grader</td>
533 </tr>
534
535
536
537 <tr>
538
539 <td class="name"><code>turnedIn</code></td>
540
541
542 <td class="type">
543
544
545<span class="param-type">boolean</span>
546
547
548
549 </td>
550
551
552 <td class="attributes">
553
554 &lt;optional><br>
555
556
557
558 </td>
559
560
561
562
563 <td class="description last">True if the assignment is turned in</td>
564 </tr>
565
566
567
568 <tr>
569
570 <td class="name"><code>late</code></td>
571
572
573 <td class="type">
574
575
576<span class="param-type">boolean</span>
577
578
579
580 </td>
581
582
583 <td class="attributes">
584
585 &lt;optional><br>
586
587
588
589 </td>
590
591
592
593
594 <td class="description last">True if the assignment is late</td>
595 </tr>
596
597
598
599 <tr>
600
601 <td class="name"><code>missing</code></td>
602
603
604 <td class="type">
605
606
607<span class="param-type">boolean</span>
608
609
610
611 </td>
612
613
614 <td class="attributes">
615
616 &lt;optional><br>
617
618
619
620 </td>
621
622
623
624
625 <td class="description last">True if the assignment is missing</td>
626 </tr>
627
628
629
630 <tr>
631
632 <td class="name"><code>locked</code></td>
633
634
635 <td class="type">
636
637
638<span class="param-type">boolean</span>
639
640
641
642 </td>
643
644
645 <td class="attributes">
646
647 &lt;optional><br>
648
649
650
651 </td>
652
653
654
655
656 <td class="description last">True if assignment submissions are locked</td>
657 </tr>
658
659
660
661 <tr>
662
663 <td class="name"><code>category</code></td>
664
665
666 <td class="type">
667
668
669<span class="param-type">string</span>
670
671
672
673 </td>
674
675
676 <td class="attributes">
677
678 &lt;optional><br>
679
680
681
682 </td>
683
684
685
686
687 <td class="description last">Assignment category</td>
688 </tr>
689
690
691
692 <tr>
693
694 <td class="name"><code>publishedAt</code></td>
695
696
697 <td class="type">
698
699
700<span class="param-type"><a href="global.html#Date">Date</a></span>
701
702
703
704 </td>
705
706
707 <td class="attributes">
708
709 &lt;optional><br>
710
711
712
713 </td>
714
715
716
717
718 <td class="description last">Date for when the assignment was published</td>
719 </tr>
720
721
722
723 <tr>
724
725 <td class="name"><code>gradedAt</code></td>
726
727
728 <td class="type">
729
730
731<span class="param-type"><a href="global.html#Date">Date</a></span>
732
733
734
735 </td>
736
737
738 <td class="attributes">
739
740 &lt;optional><br>
741
742
743
744 </td>
745
746
747
748
749 <td class="description last">Date for when the assignment was graded</td>
750 </tr>
751
752
753
754 <tr>
755
756 <td class="name"><code>grade</code></td>
757
758
759 <td class="type">
760
761
762<span class="param-type">number</span>
763
764
765
766 </td>
767
768
769 <td class="attributes">
770
771 &lt;optional><br>
772
773
774
775 </td>
776
777
778
779
780 <td class="description last">Points earned on this assignment</td>
781 </tr>
782
783
784
785 <tr>
786
787 <td class="name"><code>letter</code></td>
788
789
790 <td class="type">
791
792
793<span class="param-type">string</span>
794
795
796
797 </td>
798
799
800 <td class="attributes">
801
802 &lt;optional><br>
803
804
805
806 </td>
807
808
809
810
811 <td class="description last">Letter grade on this assignment</td>
812 </tr>
813
814
815
816 <tr>
817
818 <td class="name"><code>value</code></td>
819
820
821 <td class="type">
822
823
824<span class="param-type">number</span>
825
826
827
828 </td>
829
830
831 <td class="attributes">
832
833 &lt;optional><br>
834
835
836
837 </td>
838
839
840
841
842 <td class="description last">Total amount of points possible for this assignment</td>
843 </tr>
844
845
846
847 <tr>
848
849 <td class="name"><code>rubric</code></td>
850
851
852 <td class="type">
853
854
855<span class="param-type">Array.&lt;<a href="global.html#RubricItem">RubricItem</a>></span>
856
857
858
859 </td>
860
861
862 <td class="attributes">
863
864 &lt;optional><br>
865
866
867
868 </td>
869
870
871
872
873 <td class="description last">Assignment rubric</td>
874 </tr>
875
876
877 </tbody>
878</table>
879
880
881
882
883<dl class="details">
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910 <dt class="tag-source">Source:</dt>
911 <dd class="tag-source"><ul class="dummy"><li>
j35a697e2020-07-24 20:28:00 -0700912 <a href="assignments.js.html">assignments.js</a>, <a href="assignments.js.html#line982">line 982</a>
j1c53f822020-06-07 15:32:06 -0700913 </li></ul></dd>
914
915
916
917
918
919
920
921</dl>
922
923
924
925
926
927
928
929
930<h4 class="name" id="AssignmentFeedback">AssignmentFeedback</h4>
931
932
933
934
935<div class="description">
936 Defines assignment feedback objects in DTPS
937</div>
938
939
940
941 <h5>Type:</h5>
942 <ul>
943 <li>
944
945<span class="param-type">Object</span>
946
947
948 </li>
949 </ul>
950
951
952
953
954
955 <h5 class="subsection-title">Properties:</h5>
956
957
958
959<table class="props">
960 <thead>
961 <tr>
962
963 <th>Name</th>
964
965
966 <th>Type</th>
967
968
969 <th>Attributes</th>
970
971
972
973
974 <th class="last">Description</th>
975 </tr>
976 </thead>
977
978 <tbody>
979
980
981 <tr>
982
983 <td class="name"><code>comment</code></td>
984
985
986 <td class="type">
987
988
989<span class="param-type">string</span>
990
991
992
993 </td>
994
995
996 <td class="attributes">
997
998
999
1000 </td>
1001
1002
1003
1004
1005 <td class="description last">Feedback comment</td>
1006 </tr>
1007
1008
1009
1010 <tr>
1011
1012 <td class="name"><code>author</code></td>
1013
1014
1015 <td class="type">
1016
1017
1018<span class="param-type"><a href="global.html#User">User</a></span>
1019
1020
1021
1022 </td>
1023
1024
1025 <td class="attributes">
1026
1027 &lt;optional><br>
1028
1029
1030
1031 </td>
1032
1033
1034
1035
1036 <td class="description last">Feedback author</td>
1037 </tr>
1038
1039
1040 </tbody>
1041</table>
1042
1043
1044
1045
1046<dl class="details">
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073 <dt class="tag-source">Source:</dt>
1074 <dd class="tag-source"><ul class="dummy"><li>
j35a697e2020-07-24 20:28:00 -07001075 <a href="assignments.js.html">assignments.js</a>, <a href="assignments.js.html#line1032">line 1032</a>
j1c53f822020-06-07 15:32:06 -07001076 </li></ul></dd>
1077
1078
1079
1080
1081
1082
1083
1084</dl>
1085
1086
1087
1088
1089
1090
1091
1092
1093<h4 class="name" id="Class">Class</h4>
1094
1095
1096
1097
1098<div class="description">
1099 Defines class objects in DTPS
1100</div>
1101
1102
1103
1104 <h5>Type:</h5>
1105 <ul>
1106 <li>
1107
1108<span class="param-type">Object</span>
1109
1110
1111 </li>
1112 </ul>
1113
1114
1115
1116
1117
1118 <h5 class="subsection-title">Properties:</h5>
1119
1120
1121
1122<table class="props">
1123 <thead>
1124 <tr>
1125
1126 <th>Name</th>
1127
1128
1129 <th>Type</th>
1130
1131
1132 <th>Attributes</th>
1133
1134
1135
1136
1137 <th class="last">Description</th>
1138 </tr>
1139 </thead>
1140
1141 <tbody>
1142
1143
1144 <tr>
1145
1146 <td class="name"><code>name</code></td>
1147
1148
1149 <td class="type">
1150
1151
1152<span class="param-type">string</span>
1153
1154
1155
1156 </td>
1157
1158
1159 <td class="attributes">
1160
1161
1162
1163 </td>
1164
1165
1166
1167
1168 <td class="description last">Name of the class</td>
1169 </tr>
1170
1171
1172
1173 <tr>
1174
1175 <td class="name"><code>id</code></td>
1176
1177
1178 <td class="type">
1179
1180
1181<span class="param-type">string</span>
1182
1183
1184
1185 </td>
1186
1187
1188 <td class="attributes">
1189
1190
1191
1192 </td>
1193
1194
1195
1196
1197 <td class="description last">Class ID</td>
1198 </tr>
1199
1200
1201
1202 <tr>
1203
1204 <td class="name"><code>num</code></td>
1205
1206
1207 <td class="type">
1208
1209
1210<span class="param-type">number</span>
1211
1212
1213
1214 </td>
1215
1216
1217 <td class="attributes">
1218
1219
1220
1221 </td>
1222
1223
1224
1225
1226 <td class="description last">Index of the class in the dtps.classes array</td>
1227 </tr>
1228
1229
1230
1231 <tr>
1232
1233 <td class="name"><code>subject</code></td>
1234
1235
1236 <td class="type">
1237
1238
1239<span class="param-type">string</span>
1240
1241
1242
1243 </td>
1244
1245
1246 <td class="attributes">
1247
1248
1249
1250 </td>
1251
1252
1253
1254
1255 <td class="description last">Class subject</td>
1256 </tr>
1257
1258
1259
1260 <tr>
1261
1262 <td class="name"><code>assignments</code></td>
1263
1264
1265 <td class="type">
1266
1267
1268<span class="param-type">Array.&lt;<a href="global.html#Assignment">Assignment</a>></span>
1269
1270
1271
1272 </td>
1273
1274
1275 <td class="attributes">
1276
1277
1278
1279 </td>
1280
1281
1282
1283
1284 <td class="description last">Class assignments. Assume assignments are still loading if this is undefined. The class has no assignments if this is an empty array. Loaded in dtps.init.</td>
1285 </tr>
1286
1287
1288
1289 <tr>
1290
j35a697e2020-07-24 20:28:00 -07001291 <td class="name"><code>modules</code></td>
1292
1293
1294 <td class="type">
1295
1296
1297<span class="param-type">Array.&lt;<a href="global.html#Module">Module</a>></span>
1298|
1299
1300<span class="param-type">boolean</span>
1301
1302
1303
1304 </td>
1305
1306
1307 <td class="attributes">
1308
1309 &lt;optional><br>
1310
1311
1312
1313 </td>
1314
1315
1316
1317
1318 <td class="description last">Class modules. Assume this class supports the modules feature, but is not yet loaded, if this is true and that the class has no modules if this is an empty array. For LMSs that do not support modules, either keep it undefined or set it to false.</td>
1319 </tr>
1320
1321
1322
1323 <tr>
1324
j1c53f822020-06-07 15:32:06 -07001325 <td class="name"><code>discussions</code></td>
1326
1327
1328 <td class="type">
1329
1330
1331<span class="param-type">Array.&lt;<a href="global.html#DiscussionThread">DiscussionThread</a>></span>
1332|
1333
1334<span class="param-type">boolean</span>
1335
1336
1337
1338 </td>
1339
1340
1341 <td class="attributes">
1342
1343 &lt;optional><br>
1344
1345
1346
1347 </td>
1348
1349
1350
1351
1352 <td class="description last">Class discussion threads. Assume this class supports discussions, but not yet loaded, if this is true and that the class has no threads if this is an empty array. For LMSs that do not support discussions, either keep it undefined or set it to false.</td>
1353 </tr>
1354
1355
1356
1357 <tr>
1358
1359 <td class="name"><code>pages</code></td>
1360
1361
1362 <td class="type">
1363
1364
1365<span class="param-type">Array.&lt;<a href="global.html#Page">Page</a>></span>
1366|
1367
1368<span class="param-type">boolean</span>
1369
1370
1371
1372 </td>
1373
1374
1375 <td class="attributes">
1376
1377 &lt;optional><br>
1378
1379
1380
1381 </td>
1382
1383
1384
1385
1386 <td class="description last">Class pages. Assume this class supports the pages feature, but not yet loaded, if true and that the class has no pages if this is an empty array. For LMSs that do not support pages, either keep it undefined or set it to false.</td>
1387 </tr>
1388
1389
1390
1391 <tr>
1392
1393 <td class="name"><code>newDiscussionThreadURL</code></td>
1394
1395
1396 <td class="type">
1397
1398
1399<span class="param-type">string</span>
1400
1401
1402
1403 </td>
1404
1405
1406 <td class="attributes">
1407
1408 &lt;optional><br>
1409
1410
1411
1412 </td>
1413
1414
1415
1416
1417 <td class="description last">A URL the user can visit to create a new discussion thread in this class</td>
1418 </tr>
1419
1420
1421
1422 <tr>
1423
1424 <td class="name"><code>syllabus</code></td>
1425
1426
1427 <td class="type">
1428
1429
1430<span class="param-type">string</span>
1431
1432
1433
1434 </td>
1435
1436
1437 <td class="attributes">
1438
1439 &lt;optional><br>
1440
1441
1442
1443 </td>
1444
1445
1446
1447
1448 <td class="description last">Class syllabus HTML</td>
1449 </tr>
1450
1451
1452
1453 <tr>
1454
j35a697e2020-07-24 20:28:00 -07001455 <td class="name"><code>homepage</code></td>
1456
1457
1458 <td class="type">
1459
1460
1461<span class="param-type">boolean</span>
1462
1463
1464
1465 </td>
1466
1467
1468 <td class="attributes">
1469
1470 &lt;optional><br>
1471
1472
1473
1474 </td>
1475
1476
1477
1478
1479 <td class="description last">True if the class has a homepage. If a class has a homepage, dtpsLMS.fetchHomepage must be implemented.</td>
1480 </tr>
1481
1482
1483
1484 <tr>
1485
j1c53f822020-06-07 15:32:06 -07001486 <td class="name"><code>description</code></td>
1487
1488
1489 <td class="type">
1490
1491
1492<span class="param-type">string</span>
1493
1494
1495
1496 </td>
1497
1498
1499 <td class="attributes">
1500
1501 &lt;optional><br>
1502
1503
1504
1505 </td>
1506
1507
1508
1509
1510 <td class="description last">Class description HTML</td>
1511 </tr>
1512
1513
1514
1515 <tr>
1516
1517 <td class="name"><code>numStudents</code></td>
1518
1519
1520 <td class="type">
1521
1522
1523<span class="param-type">number</span>
1524
1525
1526
1527 </td>
1528
1529
1530 <td class="attributes">
1531
1532 &lt;optional><br>
1533
1534
1535
1536 </td>
1537
1538
1539
1540
1541 <td class="description last">Number of students in the class</td>
1542 </tr>
1543
1544
1545
1546 <tr>
1547
1548 <td class="name"><code>term</code></td>
1549
1550
1551 <td class="type">
1552
1553
1554<span class="param-type">string</span>
1555
1556
1557
1558 </td>
1559
1560
1561 <td class="attributes">
1562
1563 &lt;optional><br>
1564
1565
1566
1567 </td>
1568
1569
1570
1571
1572 <td class="description last">Class term</td>
1573 </tr>
1574
1575
1576
1577 <tr>
1578
1579 <td class="name"><code>color</code></td>
1580
1581
1582 <td class="type">
1583
1584
1585<span class="param-type">string</span>
1586
1587
1588
1589 </td>
1590
1591
1592 <td class="attributes">
1593
1594 &lt;optional><br>
1595
1596
1597
1598 </td>
1599
1600
1601
1602
1603 <td class="description last">Class color</td>
1604 </tr>
1605
1606
1607
1608 <tr>
1609
1610 <td class="name"><code>grade</code></td>
1611
1612
1613 <td class="type">
1614
1615
1616<span class="param-type">number</span>
1617
1618
1619
1620 </td>
1621
1622
1623 <td class="attributes">
1624
1625 &lt;optional><br>
1626
1627
1628
1629 </td>
1630
1631
1632
1633
1634 <td class="description last">Current percentage grade in the class</td>
1635 </tr>
1636
1637
1638
1639 <tr>
1640
1641 <td class="name"><code>letter</code></td>
1642
1643
1644 <td class="type">
1645
1646
1647<span class="param-type">string</span>
1648
1649
1650
1651 </td>
1652
1653
1654 <td class="attributes">
1655
1656 &lt;optional><br>
1657
1658
1659
1660 </td>
1661
1662
1663
1664
1665 <td class="description last">Current letter grade in the class</td>
1666 </tr>
1667
1668
1669
1670 <tr>
1671
1672 <td class="name"><code>previousLetter</code></td>
1673
1674
1675 <td class="type">
1676
1677
1678<span class="param-type">string</span>
1679
1680
1681
1682 </td>
1683
1684
1685 <td class="attributes">
1686
1687 &lt;optional><br>
1688
1689
1690
1691 </td>
1692
1693
1694
1695
1696 <td class="description last">Automatically managed by DTPS. The previous letter grade in this class, based on local grade history.</td>
1697 </tr>
1698
1699
1700
1701 <tr>
1702
1703 <td class="name"><code>image</code></td>
1704
1705
1706 <td class="type">
1707
1708
1709<span class="param-type">string</span>
1710
1711
1712
1713 </td>
1714
1715
1716 <td class="attributes">
1717
1718 &lt;optional><br>
1719
1720
1721
1722 </td>
1723
1724
1725
1726
1727 <td class="description last">URL to the class background image</td>
1728 </tr>
1729
1730
1731
1732 <tr>
1733
1734 <td class="name"><code>teacher</code></td>
1735
1736
1737 <td class="type">
1738
1739
1740<span class="param-type"><a href="global.html#User">User</a></span>
1741
1742
1743
1744 </td>
1745
1746
1747 <td class="attributes">
1748
1749 &lt;optional><br>
1750
1751
1752
1753 </td>
1754
1755
1756
1757
1758 <td class="description last">Class teacher</td>
1759 </tr>
1760
1761
1762
1763 <tr>
1764
1765 <td class="name"><code>hasGradebook</code></td>
1766
1767
1768 <td class="type">
1769
1770
1771<span class="param-type">boolean</span>
1772
1773
1774
1775 </td>
1776
1777
1778 <td class="attributes">
1779
1780 &lt;optional><br>
1781
1782
1783
1784 </td>
1785
1786
1787
1788
1789 <td class="description last">Automatically managed by DTPS. True if the class should show the gradebook tab.</td>
1790 </tr>
1791
1792
1793
1794 <tr>
1795
1796 <td class="name"><code>gradeCalculation</code></td>
1797
1798
1799 <td class="type">
1800
1801
1802<span class="param-type">object</span>
1803
1804
1805
1806 </td>
1807
1808
1809 <td class="attributes">
1810
1811 &lt;optional><br>
1812
1813
1814
1815 </td>
1816
1817
1818
1819
1820 <td class="description last">Automatically managed by DTPS. If custom grade calculation is implemented, this will be the results from custom grade calculation returned by dtpsLMS.calculateGrade.</td>
1821 </tr>
1822
1823
1824 </tbody>
1825</table>
1826
1827
1828
1829
1830<dl class="details">
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857 <dt class="tag-source">Source:</dt>
1858 <dd class="tag-source"><ul class="dummy"><li>
j35a697e2020-07-24 20:28:00 -07001859 <a href="core.js.html">core.js</a>, <a href="core.js.html#line1609">line 1609</a>
j1c53f822020-06-07 15:32:06 -07001860 </li></ul></dd>
1861
1862
1863
1864
1865
1866
1867
1868</dl>
1869
1870
1871
1872
1873
1874
1875
1876
1877<h4 class="name" id="DashboardItem">DashboardItem</h4>
1878
1879
1880
1881
1882<div class="description">
1883 Defines dashboard items in DTPS
1884</div>
1885
1886
1887
1888 <h5>Type:</h5>
1889 <ul>
1890 <li>
1891
1892<span class="param-type">Object</span>
1893
1894
1895 </li>
1896 </ul>
1897
1898
1899
1900
1901
1902 <h5 class="subsection-title">Properties:</h5>
1903
1904
1905
1906<table class="props">
1907 <thead>
1908 <tr>
1909
1910 <th>Name</th>
1911
1912
1913 <th>Type</th>
1914
1915
1916
1917
1918
1919 <th class="last">Description</th>
1920 </tr>
1921 </thead>
1922
1923 <tbody>
1924
1925
1926 <tr>
1927
1928 <td class="name"><code>name</code></td>
1929
1930
1931 <td class="type">
1932
1933
1934<span class="param-type">string</span>
1935
1936
1937
1938 </td>
1939
1940
1941
1942
1943
1944 <td class="description last">Dashbord item name</td>
1945 </tr>
1946
1947
1948
1949 <tr>
1950
1951 <td class="name"><code>id</code></td>
1952
1953
1954 <td class="type">
1955
1956
1957<span class="param-type">string</span>
1958
1959
1960
1961 </td>
1962
1963
1964
1965
1966
1967 <td class="description last">Unique dashboard item ID</td>
1968 </tr>
1969
1970
1971
1972 <tr>
1973
1974 <td class="name"><code>icon</code></td>
1975
1976
1977 <td class="type">
1978
1979
1980<span class="param-type">string</span>
1981
1982
1983
1984 </td>
1985
1986
1987
1988
1989
1990 <td class="description last">Dashboard item icon</td>
1991 </tr>
1992
1993
1994
1995 <tr>
1996
1997 <td class="name"><code>supportsCompactMode</code></td>
1998
1999
2000 <td class="type">
2001
2002
2003<span class="param-type">boolean</span>
2004
2005
2006
2007 </td>
2008
2009
2010
2011
2012
2013 <td class="description last">True if this dashboard item supports compact mode</td>
2014 </tr>
2015
2016
2017
2018 <tr>
2019
2020 <td class="name"><code>size</code></td>
2021
2022
2023 <td class="type">
2024
2025
2026<span class="param-type">number</span>
2027
2028
2029
2030 </td>
2031
2032
2033
2034
2035
2036 <td class="description last">The approximate size of this dashboard item relative to other dashboard items. Should be no less than 20.</td>
2037 </tr>
2038
2039
2040
2041 <tr>
2042
2043 <td class="name"><code>defaultSide</code></td>
2044
2045
2046 <td class="type">
2047
2048
2049<span class="param-type">string</span>
2050
2051
2052
2053 </td>
2054
2055
2056
2057
2058
2059 <td class="description last">The default side of this dashboard item. Either "right" or "left".</td>
2060 </tr>
2061
2062
2063
2064 <tr>
2065
2066 <td class="name"><code>compact</code></td>
2067
2068
2069 <td class="type">
2070
2071
2072<span class="param-type">boolean</span>
2073
2074
2075
2076 </td>
2077
2078
2079
2080
2081
2082 <td class="description last">True if the user has turned on compact mode for this item.</td>
2083 </tr>
2084
2085
2086 </tbody>
2087</table>
2088
2089
2090
2091
2092<dl class="details">
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119 <dt class="tag-source">Source:</dt>
2120 <dd class="tag-source"><ul class="dummy"><li>
j35a697e2020-07-24 20:28:00 -07002121 <a href="assignments.js.html">assignments.js</a>, <a href="assignments.js.html#line1052">line 1052</a>
j1c53f822020-06-07 15:32:06 -07002122 </li></ul></dd>
2123
2124
2125
2126
2127
2128
2129
2130</dl>
2131
2132
2133
2134
2135
2136
2137
2138
2139<h4 class="name" id="Date">Date</h4>
2140
2141
2142
2143
2144<div class="description">
2145 A date string recognized by <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/parse">Date.parse</a>
2146</div>
2147
2148
2149
2150 <h5>Type:</h5>
2151 <ul>
2152 <li>
2153
2154<span class="param-type">string</span>
2155
2156
2157 </li>
2158 </ul>
2159
2160
2161
2162
2163
2164<dl class="details">
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191 <dt class="tag-source">Source:</dt>
2192 <dd class="tag-source"><ul class="dummy"><li>
j35a697e2020-07-24 20:28:00 -07002193 <a href="core.js.html">core.js</a>, <a href="core.js.html#line1593">line 1593</a>
j1c53f822020-06-07 15:32:06 -07002194 </li></ul></dd>
2195
2196
2197
2198
2199
2200
2201
2202</dl>
2203
2204
2205
2206
2207
2208
2209
2210
2211<h4 class="name" id="DiscussionPost">DiscussionPost</h4>
2212
2213
2214
2215
2216<div class="description">
2217 Defines discussion post objects in DTPS
2218</div>
2219
2220
2221
2222 <h5>Type:</h5>
2223 <ul>
2224 <li>
2225
2226<span class="param-type">Object</span>
2227
2228
2229 </li>
2230 </ul>
2231
2232
2233
2234
2235
2236 <h5 class="subsection-title">Properties:</h5>
2237
2238
2239
2240<table class="props">
2241 <thead>
2242 <tr>
2243
2244 <th>Name</th>
2245
2246
2247 <th>Type</th>
2248
2249
2250 <th>Attributes</th>
2251
2252
2253
2254
2255 <th class="last">Description</th>
2256 </tr>
2257 </thead>
2258
2259 <tbody>
2260
2261
2262 <tr>
2263
2264 <td class="name"><code>id</code></td>
2265
2266
2267 <td class="type">
2268
2269
2270<span class="param-type">string</span>
2271
2272
2273
2274 </td>
2275
2276
2277 <td class="attributes">
2278
2279
2280
2281 </td>
2282
2283
2284
2285
2286 <td class="description last">Discussion post ID</td>
2287 </tr>
2288
2289
2290
2291 <tr>
2292
2293 <td class="name"><code>body</code></td>
2294
2295
2296 <td class="type">
2297
2298
2299<span class="param-type">string</span>
2300
2301
2302
2303 </td>
2304
2305
2306 <td class="attributes">
2307
2308
2309
2310 </td>
2311
2312
2313
2314
2315 <td class="description last">Discussion post body HTML</td>
2316 </tr>
2317
2318
2319
2320 <tr>
2321
2322 <td class="name"><code>postedAt</code></td>
2323
2324
2325 <td class="type">
2326
2327
2328<span class="param-type"><a href="global.html#Date">Date</a></span>
2329
2330
2331
2332 </td>
2333
2334
2335 <td class="attributes">
2336
2337
2338
2339 </td>
2340
2341
2342
2343
2344 <td class="description last">Date for when the post was posted</td>
2345 </tr>
2346
2347
2348
2349 <tr>
2350
2351 <td class="name"><code>depth</code></td>
2352
2353
2354 <td class="type">
2355
2356
2357<span class="param-type">number</span>
2358
2359
2360
2361 </td>
2362
2363
2364 <td class="attributes">
2365
2366 &lt;optional><br>
2367
2368
2369
2370 </td>
2371
2372
2373
2374
2375 <td class="description last">The depth level this post is</td>
2376 </tr>
2377
2378
2379
2380 <tr>
2381
2382 <td class="name"><code>author</code></td>
2383
2384
2385 <td class="type">
2386
2387
2388<span class="param-type"><a href="global.html#User">User</a></span>
2389
2390
2391
2392 </td>
2393
2394
2395 <td class="attributes">
2396
2397 &lt;optional><br>
2398
2399
2400
2401 </td>
2402
2403
2404
2405
2406 <td class="description last">Discussion post author</td>
2407 </tr>
2408
2409
2410
2411 <tr>
2412
2413 <td class="name"><code>replies</code></td>
2414
2415
2416 <td class="type">
2417
2418
2419<span class="param-type">Array.&lt;<a href="global.html#DiscussionPost">DiscussionPost</a>></span>
2420
2421
2422
2423 </td>
2424
2425
2426 <td class="attributes">
2427
2428 &lt;optional><br>
2429
2430
2431
2432 </td>
2433
2434
2435
2436
2437 <td class="description last">Replies to this post. Nested replies (replies to replies) should be after this post in the array with a depth of 1, not in the replies key.</td>
2438 </tr>
2439
2440
2441
2442 <tr>
2443
2444 <td class="name"><code>replyURL</code></td>
2445
2446
2447 <td class="type">
2448
2449
2450<span class="param-type">string</span>
2451
2452
2453
2454 </td>
2455
2456
2457 <td class="attributes">
2458
2459 &lt;optional><br>
2460
2461
2462
2463 </td>
2464
2465
2466
2467
2468 <td class="description last">A URL that the user can visit to reply to this post</td>
2469 </tr>
2470
2471
2472 </tbody>
2473</table>
2474
2475
2476
2477
2478<dl class="details">
2479
2480
2481
2482
2483
2484
2485
2486
2487
2488
2489
2490
2491
2492
2493
2494
2495
2496
2497
2498
2499
2500
2501
2502
2503
2504
2505 <dt class="tag-source">Source:</dt>
2506 <dd class="tag-source"><ul class="dummy"><li>
j35a697e2020-07-24 20:28:00 -07002507 <a href="pages-discussions.js.html">pages-discussions.js</a>, <a href="pages-discussions.js.html#line480">line 480</a>
j1c53f822020-06-07 15:32:06 -07002508 </li></ul></dd>
2509
2510
2511
2512
2513
2514
2515
2516</dl>
2517
2518
2519
2520
2521
2522
2523
2524
2525<h4 class="name" id="DiscussionThread">DiscussionThread</h4>
2526
2527
2528
2529
2530<div class="description">
2531 Defines discussion thread objects in DTPS
2532</div>
2533
2534
2535
2536 <h5>Type:</h5>
2537 <ul>
2538 <li>
2539
2540<span class="param-type">Object</span>
2541
2542
2543 </li>
2544 </ul>
2545
2546
2547
2548
2549
2550 <h5 class="subsection-title">Properties:</h5>
2551
2552
2553
2554<table class="props">
2555 <thead>
2556 <tr>
2557
2558 <th>Name</th>
2559
2560
2561 <th>Type</th>
2562
2563
2564 <th>Attributes</th>
2565
2566
2567
2568
2569 <th class="last">Description</th>
2570 </tr>
2571 </thead>
2572
2573 <tbody>
2574
2575
2576 <tr>
2577
2578 <td class="name"><code>title</code></td>
2579
2580
2581 <td class="type">
2582
2583
2584<span class="param-type">string</span>
2585
2586
2587
2588 </td>
2589
2590
2591 <td class="attributes">
2592
2593
2594
2595 </td>
2596
2597
2598
2599
2600 <td class="description last">Title of the discussion thread</td>
2601 </tr>
2602
2603
2604
2605 <tr>
2606
2607 <td class="name"><code>id</code></td>
2608
2609
2610 <td class="type">
2611
2612
2613<span class="param-type">string</span>
2614
2615
2616
2617 </td>
2618
2619
2620 <td class="attributes">
2621
2622
2623
2624 </td>
2625
2626
2627
2628
2629 <td class="description last">Discussion thread ID</td>
2630 </tr>
2631
2632
2633
2634 <tr>
2635
2636 <td class="name"><code>posts</code></td>
2637
2638
2639 <td class="type">
2640
2641
2642<span class="param-type">Array.&lt;<a href="global.html#DiscussionPost">DiscussionPost</a>></span>
2643
2644
2645
2646 </td>
2647
2648
2649 <td class="attributes">
2650
2651
2652
2653 </td>
2654
2655
2656
2657
2658 <td class="description last">Posts in this thread, with the initial one first. Assume that the topic has not been selected and loaded if this is undefined, and that there are no posts if this is an empty array.</td>
2659 </tr>
2660
2661
2662
2663 <tr>
2664
2665 <td class="name"><code>locked</code></td>
2666
2667
2668 <td class="type">
2669
2670
2671<span class="param-type">boolean</span>
2672
2673
2674
2675 </td>
2676
2677
2678 <td class="attributes">
2679
2680 &lt;optional><br>
2681
2682
2683
2684 </td>
2685
2686
2687
2688
2689 <td class="description last">True if posting to the discussion thread is locked</td>
2690 </tr>
2691
2692
2693
2694 <tr>
2695
2696 <td class="name"><code>requireInitialPost</code></td>
2697
2698
2699 <td class="type">
2700
2701
2702<span class="param-type">boolean</span>
2703
2704
2705
2706 </td>
2707
2708
2709 <td class="attributes">
2710
2711 &lt;optional><br>
2712
2713
2714
2715 </td>
2716
2717
2718
2719
2720 <td class="description last">True if the user must post before viewing others' posts</td>
2721 </tr>
2722
2723
2724 </tbody>
2725</table>
2726
2727
2728
2729
2730<dl class="details">
2731
2732
2733
2734
2735
2736
2737
2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757 <dt class="tag-source">Source:</dt>
2758 <dd class="tag-source"><ul class="dummy"><li>
j35a697e2020-07-24 20:28:00 -07002759 <a href="pages-discussions.js.html">pages-discussions.js</a>, <a href="pages-discussions.js.html#line470">line 470</a>
2760 </li></ul></dd>
2761
2762
2763
2764
2765
2766
2767
2768</dl>
2769
2770
2771
2772
2773
2774
2775
2776
2777<h4 class="name" id="Module">Module</h4>
2778
2779
2780
2781
2782<div class="description">
2783 Defines module objects in DTPS
2784</div>
2785
2786
2787
2788 <h5>Type:</h5>
2789 <ul>
2790 <li>
2791
2792<span class="param-type">Object</span>
2793
2794
2795 </li>
2796 </ul>
2797
2798
2799
2800
2801
2802 <h5 class="subsection-title">Properties:</h5>
2803
2804
2805
2806<table class="props">
2807 <thead>
2808 <tr>
2809
2810 <th>Name</th>
2811
2812
2813 <th>Type</th>
2814
2815
2816 <th>Attributes</th>
2817
2818
2819
2820
2821 <th class="last">Description</th>
2822 </tr>
2823 </thead>
2824
2825 <tbody>
2826
2827
2828 <tr>
2829
2830 <td class="name"><code>title</code></td>
2831
2832
2833 <td class="type">
2834
2835
2836<span class="param-type">string</span>
2837
2838
2839
2840 </td>
2841
2842
2843 <td class="attributes">
2844
2845
2846
2847 </td>
2848
2849
2850
2851
2852 <td class="description last">Title of the module</td>
2853 </tr>
2854
2855
2856
2857 <tr>
2858
2859 <td class="name"><code>id</code></td>
2860
2861
2862 <td class="type">
2863
2864
2865<span class="param-type">string</span>
2866
2867
2868
2869 </td>
2870
2871
2872 <td class="attributes">
2873
2874
2875
2876 </td>
2877
2878
2879
2880
2881 <td class="description last">Module ID</td>
2882 </tr>
2883
2884
2885
2886 <tr>
2887
2888 <td class="name"><code>collapsed</code></td>
2889
2890
2891 <td class="type">
2892
2893
2894<span class="param-type">boolean</span>
2895
2896
2897
2898 </td>
2899
2900
2901 <td class="attributes">
2902
2903 &lt;optional><br>
2904
2905
2906
2907 </td>
2908
2909
2910
2911
2912 <td class="description last">True if the module is collapsed, false otherwise. undefined or null if this module does not support collapsing.</td>
2913 </tr>
2914
2915
2916
2917 <tr>
2918
2919 <td class="name"><code>items</code></td>
2920
2921
2922 <td class="type">
2923
2924
2925<span class="param-type">Array.&lt;<a href="global.html#ModuleItem">ModuleItem</a>></span>
2926
2927
2928
2929 </td>
2930
2931
2932 <td class="attributes">
2933
2934
2935
2936 </td>
2937
2938
2939
2940
2941 <td class="description last">An array of items for this module.</td>
2942 </tr>
2943
2944
2945 </tbody>
2946</table>
2947
2948
2949
2950
2951<dl class="details">
2952
2953
2954
2955
2956
2957
2958
2959
2960
2961
2962
2963
2964
2965
2966
2967
2968
2969
2970
2971
2972
2973
2974
2975
2976
2977
2978 <dt class="tag-source">Source:</dt>
2979 <dd class="tag-source"><ul class="dummy"><li>
2980 <a href="assignments.js.html">assignments.js</a>, <a href="assignments.js.html#line1005">line 1005</a>
2981 </li></ul></dd>
2982
2983
2984
2985
2986
2987
2988
2989</dl>
2990
2991
2992
2993
2994
2995
2996
2997
2998<h4 class="name" id="ModuleItem">ModuleItem</h4>
2999
3000
3001
3002
3003<div class="description">
3004 Defines module items in DTPS
3005</div>
3006
3007
3008
3009 <h5>Type:</h5>
3010 <ul>
3011 <li>
3012
3013<span class="param-type">Object</span>
3014
3015
3016 </li>
3017 </ul>
3018
3019
3020
3021
3022
3023 <h5 class="subsection-title">Properties:</h5>
3024
3025
3026
3027<table class="props">
3028 <thead>
3029 <tr>
3030
3031 <th>Name</th>
3032
3033
3034 <th>Type</th>
3035
3036
3037 <th>Attributes</th>
3038
3039
3040
3041
3042 <th class="last">Description</th>
3043 </tr>
3044 </thead>
3045
3046 <tbody>
3047
3048
3049 <tr>
3050
3051 <td class="name"><code>type</code></td>
3052
3053
3054 <td class="type">
3055
3056
3057<span class="param-type">string</span>
3058
3059
3060
3061 </td>
3062
3063
3064 <td class="attributes">
3065
3066
3067
3068 </td>
3069
3070
3071
3072
3073 <td class="description last">Either "assignment", "page", "discussion", "url", "embed", or "header".</td>
3074 </tr>
3075
3076
3077
3078 <tr>
3079
3080 <td class="name"><code>title</code></td>
3081
3082
3083 <td class="type">
3084
3085
3086<span class="param-type">string</span>
3087
3088
3089
3090 </td>
3091
3092
3093 <td class="attributes">
3094
3095 &lt;optional><br>
3096
3097
3098
3099 </td>
3100
3101
3102
3103
3104 <td class="description last">Required for URL and header items, and can be used to override the title of assignment, page, and discussion items.</td>
3105 </tr>
3106
3107
3108
3109 <tr>
3110
3111 <td class="name"><code>id</code></td>
3112
3113
3114 <td class="type">
3115
3116
3117<span class="param-type">string</span>
3118
3119
3120
3121 </td>
3122
3123
3124 <td class="attributes">
3125
3126 &lt;optional><br>
3127
3128
3129
3130 </td>
3131
3132
3133
3134
3135 <td class="description last">Required for assignment, page, and discussion items.</td>
3136 </tr>
3137
3138
3139
3140 <tr>
3141
3142 <td class="name"><code>url</code></td>
3143
3144
3145 <td class="type">
3146
3147
3148<span class="param-type">string</span>
3149
3150
3151
3152 </td>
3153
3154
3155 <td class="attributes">
3156
3157 &lt;optional><br>
3158
3159
3160
3161 </td>
3162
3163
3164
3165
3166 <td class="description last">Required for URL and embed items.</td>
3167 </tr>
3168
3169
3170
3171 <tr>
3172
3173 <td class="name"><code>indent</code></td>
3174
3175
3176 <td class="type">
3177
3178
3179<span class="param-type">number</span>
3180
3181
3182
3183 </td>
3184
3185
3186 <td class="attributes">
3187
3188 &lt;optional><br>
3189
3190
3191
3192 </td>
3193
3194
3195
3196
3197 <td class="description last">Indent level</td>
3198 </tr>
3199
3200
3201 </tbody>
3202</table>
3203
3204
3205
3206
3207<dl class="details">
3208
3209
3210
3211
3212
3213
3214
3215
3216
3217
3218
3219
3220
3221
3222
3223
3224
3225
3226
3227
3228
3229
3230
3231
3232
3233
3234 <dt class="tag-source">Source:</dt>
3235 <dd class="tag-source"><ul class="dummy"><li>
3236 <a href="assignments.js.html">assignments.js</a>, <a href="assignments.js.html#line1014">line 1014</a>
j1c53f822020-06-07 15:32:06 -07003237 </li></ul></dd>
3238
3239
3240
3241
3242
3243
3244
3245</dl>
3246
3247
3248
3249
3250
3251
3252
3253
3254<h4 class="name" id="Page">Page</h4>
3255
3256
3257
3258
3259<div class="description">
3260 Defines Page objects in DTPS
3261</div>
3262
3263
3264
3265 <h5>Type:</h5>
3266 <ul>
3267 <li>
3268
3269<span class="param-type">Object</span>
3270
3271
3272 </li>
3273 </ul>
3274
3275
3276
3277
3278
3279 <h5 class="subsection-title">Properties:</h5>
3280
3281
3282
3283<table class="props">
3284 <thead>
3285 <tr>
3286
3287 <th>Name</th>
3288
3289
3290 <th>Type</th>
3291
3292
3293 <th>Attributes</th>
3294
3295
3296
3297
3298 <th class="last">Description</th>
3299 </tr>
3300 </thead>
3301
3302 <tbody>
3303
3304
3305 <tr>
3306
3307 <td class="name"><code>title</code></td>
3308
3309
3310 <td class="type">
3311
3312
3313<span class="param-type">string</span>
3314
3315
3316
3317 </td>
3318
3319
3320 <td class="attributes">
3321
3322
3323
3324 </td>
3325
3326
3327
3328
3329 <td class="description last">Page title</td>
3330 </tr>
3331
3332
3333
3334 <tr>
3335
3336 <td class="name"><code>id</code></td>
3337
3338
3339 <td class="type">
3340
3341
3342<span class="param-type">string</span>
3343
3344
3345
3346 </td>
3347
3348
3349 <td class="attributes">
3350
3351
3352
3353 </td>
3354
3355
3356
3357
3358 <td class="description last">Page ID</td>
3359 </tr>
3360
3361
3362
3363 <tr>
3364
3365 <td class="name"><code>content</code></td>
3366
3367
3368 <td class="type">
3369
3370
3371<span class="param-type">string</span>
3372
3373
3374
3375 </td>
3376
3377
3378 <td class="attributes">
3379
3380
3381
3382 </td>
3383
3384
3385
3386
3387 <td class="description last">Page content. Assume the page hasn't been selected/loaded if this is undefined.</td>
3388 </tr>
3389
3390
3391
3392 <tr>
3393
3394 <td class="name"><code>updatedAt</code></td>
3395
3396
3397 <td class="type">
3398
3399
3400<span class="param-type"><a href="global.html#Date">Date</a></span>
3401
3402
3403
3404 </td>
3405
3406
3407 <td class="attributes">
3408
3409 &lt;optional><br>
3410
3411
3412
3413 </td>
3414
3415
3416
3417
3418 <td class="description last">When the page was last updated</td>
3419 </tr>
3420
3421
3422
3423 <tr>
3424
3425 <td class="name"><code>author</code></td>
3426
3427
3428 <td class="type">
3429
3430
3431<span class="param-type"><a href="global.html#User">User</a></span>
3432
3433
3434
3435 </td>
3436
3437
3438 <td class="attributes">
3439
3440 &lt;optional><br>
3441
3442
3443
3444 </td>
3445
3446
3447
3448
3449 <td class="description last">Page author</td>
3450 </tr>
3451
3452
3453 </tbody>
3454</table>
3455
3456
3457
3458
3459<dl class="details">
3460
3461
3462
3463
3464
3465
3466
3467
3468
3469
3470
3471
3472
3473
3474
3475
3476
3477
3478
3479
3480
3481
3482
3483
3484
3485
3486 <dt class="tag-source">Source:</dt>
3487 <dd class="tag-source"><ul class="dummy"><li>
j35a697e2020-07-24 20:28:00 -07003488 <a href="pages-discussions.js.html">pages-discussions.js</a>, <a href="pages-discussions.js.html#line492">line 492</a>
j1c53f822020-06-07 15:32:06 -07003489 </li></ul></dd>
3490
3491
3492
3493
3494
3495
3496
3497</dl>
3498
3499
3500
3501
3502
3503
3504
3505
3506<h4 class="name" id="RubricItem">RubricItem</h4>
3507
3508
3509
3510
3511<div class="description">
3512 Defines rubric item objects in DTPS
3513</div>
3514
3515
3516
3517 <h5>Type:</h5>
3518 <ul>
3519 <li>
3520
3521<span class="param-type">Object</span>
3522
3523
3524 </li>
3525 </ul>
3526
3527
3528
3529
3530
3531 <h5 class="subsection-title">Properties:</h5>
3532
3533
3534
3535<table class="props">
3536 <thead>
3537 <tr>
3538
3539 <th>Name</th>
3540
3541
3542 <th>Type</th>
3543
3544
3545 <th>Attributes</th>
3546
3547
3548
3549
3550 <th class="last">Description</th>
3551 </tr>
3552 </thead>
3553
3554 <tbody>
3555
3556
3557 <tr>
3558
3559 <td class="name"><code>title</code></td>
3560
3561
3562 <td class="type">
3563
3564
3565<span class="param-type">string</span>
3566
3567
3568
3569 </td>
3570
3571
3572 <td class="attributes">
3573
3574
3575
3576 </td>
3577
3578
3579
3580
3581 <td class="description last">Title of the rubric item</td>
3582 </tr>
3583
3584
3585
3586 <tr>
3587
3588 <td class="name"><code>id</code></td>
3589
3590
3591 <td class="type">
3592
3593
3594<span class="param-type">string</span>
3595
3596
3597
3598 </td>
3599
3600
3601 <td class="attributes">
3602
3603
3604
3605 </td>
3606
3607
3608
3609
3610 <td class="description last">Rubric item ID (does NOT have to be unique)</td>
3611 </tr>
3612
3613
3614
3615 <tr>
3616
3617 <td class="name"><code>value</code></td>
3618
3619
3620 <td class="type">
3621
3622
3623<span class="param-type">number</span>
3624
3625
3626
3627 </td>
3628
3629
3630 <td class="attributes">
3631
3632
3633
3634 </td>
3635
3636
3637
3638
3639 <td class="description last">Total amount of points possible</td>
3640 </tr>
3641
3642
3643
3644 <tr>
3645
3646 <td class="name"><code>outcome</code></td>
3647
3648
3649 <td class="type">
3650
3651
3652<span class="param-type">string</span>
3653
3654
3655
3656 </td>
3657
3658
3659 <td class="attributes">
3660
3661 &lt;optional><br>
3662
3663
3664
3665 </td>
3666
3667
3668
3669
3670 <td class="description last">The ID of the outcome this rubric item is assessing. This is only used for grade calculation.</td>
3671 </tr>
3672
3673
3674
3675 <tr>
3676
3677 <td class="name"><code>description</code></td>
3678
3679
3680 <td class="type">
3681
3682
3683<span class="param-type">string</span>
3684
3685
3686
3687 </td>
3688
3689
3690 <td class="attributes">
3691
3692 &lt;optional><br>
3693
3694
3695
3696 </td>
3697
3698
3699
3700
3701 <td class="description last">Rubric item description</td>
3702 </tr>
3703
3704
3705
3706 <tr>
3707
3708 <td class="name"><code>score</code></td>
3709
3710
3711 <td class="type">
3712
3713
3714<span class="param-type">number</span>
3715
3716
3717
3718 </td>
3719
3720
3721 <td class="attributes">
3722
3723 &lt;optional><br>
3724
3725
3726
3727 </td>
3728
3729
3730
3731
3732 <td class="description last">Rubric assessment score in points</td>
3733 </tr>
3734
3735
3736
3737 <tr>
3738
3739 <td class="name"><code>scoreName</code></td>
3740
3741
3742 <td class="type">
3743
3744
3745<span class="param-type">string</span>
3746
3747
3748
3749 </td>
3750
3751
3752 <td class="attributes">
3753
3754 &lt;optional><br>
3755
3756
3757
3758 </td>
3759
3760
3761
3762
3763 <td class="description last">Rubric assessment score name</td>
3764 </tr>
3765
3766
3767
3768 <tr>
3769
3770 <td class="name"><code>scoreColor</code></td>
3771
3772
3773 <td class="type">
3774
3775
3776<span class="param-type">string</span>
3777
3778
3779
3780 </td>
3781
3782
3783 <td class="attributes">
3784
3785 &lt;optional><br>
3786
3787
3788
3789 </td>
3790
3791
3792
3793
3794 <td class="description last">Score color in CSS color format</td>
3795 </tr>
3796
3797
3798 </tbody>
3799</table>
3800
3801
3802
3803
3804<dl class="details">
3805
3806
3807
3808
3809
3810
3811
3812
3813
3814
3815
3816
3817
3818
3819
3820
3821
3822
3823
3824
3825
3826
3827
3828
3829
3830
3831 <dt class="tag-source">Source:</dt>
3832 <dd class="tag-source"><ul class="dummy"><li>
j35a697e2020-07-24 20:28:00 -07003833 <a href="assignments.js.html">assignments.js</a>, <a href="assignments.js.html#line1039">line 1039</a>
j1c53f822020-06-07 15:32:06 -07003834 </li></ul></dd>
3835
3836
3837
3838
3839
3840
3841
3842</dl>
3843
3844
3845
3846
3847
3848
3849
3850
3851<h4 class="name" id="User">User</h4>
3852
3853
3854
3855
3856<div class="description">
3857 Defines user objects in DTPS
3858</div>
3859
3860
3861
3862 <h5>Type:</h5>
3863 <ul>
3864 <li>
3865
3866<span class="param-type">Object</span>
3867
3868
3869 </li>
3870 </ul>
3871
3872
3873
3874
3875
3876 <h5 class="subsection-title">Properties:</h5>
3877
3878
3879
3880<table class="props">
3881 <thead>
3882 <tr>
3883
3884 <th>Name</th>
3885
3886
3887 <th>Type</th>
3888
3889
j35a697e2020-07-24 20:28:00 -07003890 <th>Attributes</th>
3891
j1c53f822020-06-07 15:32:06 -07003892
3893
3894
3895 <th class="last">Description</th>
3896 </tr>
3897 </thead>
3898
3899 <tbody>
3900
3901
3902 <tr>
3903
3904 <td class="name"><code>name</code></td>
3905
3906
3907 <td class="type">
3908
3909
3910<span class="param-type">string</span>
3911
3912
3913
3914 </td>
3915
3916
j35a697e2020-07-24 20:28:00 -07003917 <td class="attributes">
3918
3919
3920
3921 </td>
3922
j1c53f822020-06-07 15:32:06 -07003923
3924
3925
3926 <td class="description last">User name</td>
3927 </tr>
3928
3929
3930
3931 <tr>
3932
3933 <td class="name"><code>id</code></td>
3934
3935
3936 <td class="type">
3937
3938
3939<span class="param-type">string</span>
3940
3941
3942
3943 </td>
3944
3945
j35a697e2020-07-24 20:28:00 -07003946 <td class="attributes">
3947
3948
3949
3950 </td>
3951
j1c53f822020-06-07 15:32:06 -07003952
3953
3954
3955 <td class="description last">User ID</td>
3956 </tr>
3957
3958
3959
3960 <tr>
3961
3962 <td class="name"><code>photoURL</code></td>
3963
3964
3965 <td class="type">
3966
3967
3968<span class="param-type">string</span>
3969
3970
3971
3972 </td>
3973
3974
j35a697e2020-07-24 20:28:00 -07003975 <td class="attributes">
3976
3977
3978
3979 </td>
3980
j1c53f822020-06-07 15:32:06 -07003981
3982
3983
3984 <td class="description last">User photo URL</td>
3985 </tr>
3986
3987
j35a697e2020-07-24 20:28:00 -07003988
3989 <tr>
3990
3991 <td class="name"><code>children</code></td>
3992
3993
3994 <td class="type">
3995
3996
3997<span class="param-type">Array.&lt;<a href="global.html#User">User</a>></span>
3998
3999
4000
4001 </td>
4002
4003
4004 <td class="attributes">
4005
4006 &lt;optional><br>
4007
4008
4009
4010 </td>
4011
4012
4013
4014
4015 <td class="description last">[ONLY FOR DTPS.USER] Array of child users. If this is defined, the user is treated as a parent account. Sub-children are not allowed.</td>
4016 </tr>
4017
4018
4019
4020 <tr>
4021
4022 <td class="name"><code>parent</code></td>
4023
4024
4025 <td class="type">
4026
4027
4028<span class="param-type">boolean</span>
4029
4030
4031
4032 </td>
4033
4034
4035 <td class="attributes">
4036
4037
4038
4039 </td>
4040
4041
4042
4043
4044 <td class="description last">[ONLY FOR DTPS.USER] Automatically managed by DTPS. True if the user is a parent account.</td>
4045 </tr>
4046
4047
4048
4049 <tr>
4050
4051 <td class="name"><code>lmsID</code></td>
4052
4053
4054 <td class="type">
4055
4056
4057<span class="param-type">string</span>
4058
4059
4060
4061 </td>
4062
4063
4064 <td class="attributes">
4065
4066
4067
4068 </td>
4069
4070
4071
4072
4073 <td class="description last">[ONLY FOR DTPS.USER] Automatically managed by DTPS. This is the user ID that all LMS web requests should use. Can change when a parent account changes the selected child.</td>
4074 </tr>
4075
4076
j1c53f822020-06-07 15:32:06 -07004077 </tbody>
4078</table>
4079
4080
4081
4082
4083<dl class="details">
4084
4085
4086
4087
4088
4089
4090
4091
4092
4093
4094
4095
4096
4097
4098
4099
4100
4101
4102
4103
4104
4105
4106
4107
4108
4109
4110 <dt class="tag-source">Source:</dt>
4111 <dd class="tag-source"><ul class="dummy"><li>
j35a697e2020-07-24 20:28:00 -07004112 <a href="core.js.html">core.js</a>, <a href="core.js.html#line1598">line 1598</a>
j1c53f822020-06-07 15:32:06 -07004113 </li></ul></dd>
4114
4115
4116
4117
4118
4119
4120
4121</dl>
4122
4123
4124
4125
4126
4127
4128
4129
4130
4131
4132</article>
4133
4134</section>
4135
4136
4137
4138
4139</div>
4140
4141<nav>
4142 <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>
4143</nav>
4144
4145<br class="clear">
4146
4147<footer>
j35a697e2020-07-24 20:28:00 -07004148 Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.5</a> on Fri Jul 24 2020 19:25:37 GMT-0700 (Pacific Daylight Time)
j1c53f822020-06-07 15:32:06 -07004149</footer>
4150
4151<script> prettyPrint(); </script>
4152<script src="scripts/linenumber.js"> </script>
4153</body>
4154</html>