blob: 3eed7262e9876c12544a23e93eb4c81c10bf5602 [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
105<h4 class="name" id="Assignment">Assignment</h4>
106
107
108
109
110<div class="description">
111 Defines assignments 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 <th>Attributes</th>
145
146
147
148
149 <th class="last">Description</th>
150 </tr>
151 </thead>
152
153 <tbody>
154
155
156 <tr>
157
158 <td class="name"><code>title</code></td>
159
160
161 <td class="type">
162
163
164<span class="param-type">string</span>
165
166
167
168 </td>
169
170
171 <td class="attributes">
172
173
174
175 </td>
176
177
178
179
180 <td class="description last">Title of the assignment</td>
181 </tr>
182
183
184
185 <tr>
186
187 <td class="name"><code>body</code></td>
188
189
190 <td class="type">
191
192
193<span class="param-type">string</span>
194
195
196
197 </td>
198
199
200 <td class="attributes">
201
202 &lt;optional><br>
203
204
205
206 </td>
207
208
209
210
211 <td class="description last">HTML of the assignment's body</td>
212 </tr>
213
214
215
216 <tr>
217
218 <td class="name"><code>id</code></td>
219
220
221 <td class="type">
222
223
224<span class="param-type">string</span>
225
226
227
228 </td>
229
230
231 <td class="attributes">
232
233
234
235 </td>
236
237
238
239
240 <td class="description last">Assignment ID</td>
241 </tr>
242
243
244
245 <tr>
246
247 <td class="name"><code>dueAt</code></td>
248
249
250 <td class="type">
251
252
253<span class="param-type"><a href="global.html#Date">Date</a></span>
254
255
256
257 </td>
258
259
260 <td class="attributes">
261
262 &lt;optional><br>
263
264
265
266 </td>
267
268
269
270
271 <td class="description last">Assignment due date</td>
272 </tr>
273
274
275
276 <tr>
277
278 <td class="name"><code>url</code></td>
279
280
281 <td class="type">
282
283
284<span class="param-type">string</span>
285
286
287
288 </td>
289
290
291 <td class="attributes">
292
293
294
295 </td>
296
297
298
299
300 <td class="description last">Assignment URL</td>
301 </tr>
302
303
304
305 <tr>
306
307 <td class="name"><code>feedback</code></td>
308
309
310 <td class="type">
311
312
313<span class="param-type">Array.&lt;<a href="global.html#AssignmentFeedback">AssignmentFeedback</a>></span>
314
315
316
317 </td>
318
319
320 <td class="attributes">
321
322 &lt;optional><br>
323
324
325
326 </td>
327
328
329
330
331 <td class="description last">Feedback / private comments for this assignment</td>
332 </tr>
333
334
335
336 <tr>
337
338 <td class="name"><code>grader</code></td>
339
340
341 <td class="type">
342
343
344<span class="param-type"><a href="global.html#User">User</a></span>
345
346
347
348 </td>
349
350
351 <td class="attributes">
352
353 &lt;optional><br>
354
355
356
357 </td>
358
359
360
361
362 <td class="description last">Assignment grader</td>
363 </tr>
364
365
366
367 <tr>
368
369 <td class="name"><code>turnedIn</code></td>
370
371
372 <td class="type">
373
374
375<span class="param-type">boolean</span>
376
377
378
379 </td>
380
381
382 <td class="attributes">
383
384 &lt;optional><br>
385
386
387
388 </td>
389
390
391
392
393 <td class="description last">True if the assignment is turned in</td>
394 </tr>
395
396
397
398 <tr>
399
400 <td class="name"><code>late</code></td>
401
402
403 <td class="type">
404
405
406<span class="param-type">boolean</span>
407
408
409
410 </td>
411
412
413 <td class="attributes">
414
415 &lt;optional><br>
416
417
418
419 </td>
420
421
422
423
424 <td class="description last">True if the assignment is late</td>
425 </tr>
426
427
428
429 <tr>
430
431 <td class="name"><code>missing</code></td>
432
433
434 <td class="type">
435
436
437<span class="param-type">boolean</span>
438
439
440
441 </td>
442
443
444 <td class="attributes">
445
446 &lt;optional><br>
447
448
449
450 </td>
451
452
453
454
455 <td class="description last">True if the assignment is missing</td>
456 </tr>
457
458
459
460 <tr>
461
462 <td class="name"><code>locked</code></td>
463
464
465 <td class="type">
466
467
468<span class="param-type">boolean</span>
469
470
471
472 </td>
473
474
475 <td class="attributes">
476
477 &lt;optional><br>
478
479
480
481 </td>
482
483
484
485
486 <td class="description last">True if assignment submissions are locked</td>
487 </tr>
488
489
490
491 <tr>
492
493 <td class="name"><code>category</code></td>
494
495
496 <td class="type">
497
498
499<span class="param-type">string</span>
500
501
502
503 </td>
504
505
506 <td class="attributes">
507
508 &lt;optional><br>
509
510
511
512 </td>
513
514
515
516
517 <td class="description last">Assignment category</td>
518 </tr>
519
520
521
522 <tr>
523
524 <td class="name"><code>publishedAt</code></td>
525
526
527 <td class="type">
528
529
530<span class="param-type"><a href="global.html#Date">Date</a></span>
531
532
533
534 </td>
535
536
537 <td class="attributes">
538
539 &lt;optional><br>
540
541
542
543 </td>
544
545
546
547
548 <td class="description last">Date for when the assignment was published</td>
549 </tr>
550
551
552
553 <tr>
554
555 <td class="name"><code>gradedAt</code></td>
556
557
558 <td class="type">
559
560
561<span class="param-type"><a href="global.html#Date">Date</a></span>
562
563
564
565 </td>
566
567
568 <td class="attributes">
569
570 &lt;optional><br>
571
572
573
574 </td>
575
576
577
578
579 <td class="description last">Date for when the assignment was graded</td>
580 </tr>
581
582
583
584 <tr>
585
586 <td class="name"><code>grade</code></td>
587
588
589 <td class="type">
590
591
592<span class="param-type">number</span>
593
594
595
596 </td>
597
598
599 <td class="attributes">
600
601 &lt;optional><br>
602
603
604
605 </td>
606
607
608
609
610 <td class="description last">Points earned on this assignment</td>
611 </tr>
612
613
614
615 <tr>
616
617 <td class="name"><code>letter</code></td>
618
619
620 <td class="type">
621
622
623<span class="param-type">string</span>
624
625
626
627 </td>
628
629
630 <td class="attributes">
631
632 &lt;optional><br>
633
634
635
636 </td>
637
638
639
640
641 <td class="description last">Letter grade on this assignment</td>
642 </tr>
643
644
645
646 <tr>
647
648 <td class="name"><code>value</code></td>
649
650
651 <td class="type">
652
653
654<span class="param-type">number</span>
655
656
657
658 </td>
659
660
661 <td class="attributes">
662
663 &lt;optional><br>
664
665
666
667 </td>
668
669
670
671
672 <td class="description last">Total amount of points possible for this assignment</td>
673 </tr>
674
675
676
677 <tr>
678
679 <td class="name"><code>rubric</code></td>
680
681
682 <td class="type">
683
684
685<span class="param-type">Array.&lt;<a href="global.html#RubricItem">RubricItem</a>></span>
686
687
688
689 </td>
690
691
692 <td class="attributes">
693
694 &lt;optional><br>
695
696
697
698 </td>
699
700
701
702
703 <td class="description last">Assignment rubric</td>
704 </tr>
705
706
707 </tbody>
708</table>
709
710
711
712
713<dl class="details">
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740 <dt class="tag-source">Source:</dt>
741 <dd class="tag-source"><ul class="dummy"><li>
742 <a href="assignments.js.html">assignments.js</a>, <a href="assignments.js.html#line782">line 782</a>
743 </li></ul></dd>
744
745
746
747
748
749
750
751</dl>
752
753
754
755
756
757
758
759
760<h4 class="name" id="AssignmentFeedback">AssignmentFeedback</h4>
761
762
763
764
765<div class="description">
766 Defines assignment feedback objects in DTPS
767</div>
768
769
770
771 <h5>Type:</h5>
772 <ul>
773 <li>
774
775<span class="param-type">Object</span>
776
777
778 </li>
779 </ul>
780
781
782
783
784
785 <h5 class="subsection-title">Properties:</h5>
786
787
788
789<table class="props">
790 <thead>
791 <tr>
792
793 <th>Name</th>
794
795
796 <th>Type</th>
797
798
799 <th>Attributes</th>
800
801
802
803
804 <th class="last">Description</th>
805 </tr>
806 </thead>
807
808 <tbody>
809
810
811 <tr>
812
813 <td class="name"><code>comment</code></td>
814
815
816 <td class="type">
817
818
819<span class="param-type">string</span>
820
821
822
823 </td>
824
825
826 <td class="attributes">
827
828
829
830 </td>
831
832
833
834
835 <td class="description last">Feedback comment</td>
836 </tr>
837
838
839
840 <tr>
841
842 <td class="name"><code>author</code></td>
843
844
845 <td class="type">
846
847
848<span class="param-type"><a href="global.html#User">User</a></span>
849
850
851
852 </td>
853
854
855 <td class="attributes">
856
857 &lt;optional><br>
858
859
860
861 </td>
862
863
864
865
866 <td class="description last">Feedback author</td>
867 </tr>
868
869
870 </tbody>
871</table>
872
873
874
875
876<dl class="details">
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903 <dt class="tag-source">Source:</dt>
904 <dd class="tag-source"><ul class="dummy"><li>
905 <a href="assignments.js.html">assignments.js</a>, <a href="assignments.js.html#line805">line 805</a>
906 </li></ul></dd>
907
908
909
910
911
912
913
914</dl>
915
916
917
918
919
920
921
922
923<h4 class="name" id="Class">Class</h4>
924
925
926
927
928<div class="description">
929 Defines class objects in DTPS
930</div>
931
932
933
934 <h5>Type:</h5>
935 <ul>
936 <li>
937
938<span class="param-type">Object</span>
939
940
941 </li>
942 </ul>
943
944
945
946
947
948 <h5 class="subsection-title">Properties:</h5>
949
950
951
952<table class="props">
953 <thead>
954 <tr>
955
956 <th>Name</th>
957
958
959 <th>Type</th>
960
961
962 <th>Attributes</th>
963
964
965
966
967 <th class="last">Description</th>
968 </tr>
969 </thead>
970
971 <tbody>
972
973
974 <tr>
975
976 <td class="name"><code>name</code></td>
977
978
979 <td class="type">
980
981
982<span class="param-type">string</span>
983
984
985
986 </td>
987
988
989 <td class="attributes">
990
991
992
993 </td>
994
995
996
997
998 <td class="description last">Name of the class</td>
999 </tr>
1000
1001
1002
1003 <tr>
1004
1005 <td class="name"><code>id</code></td>
1006
1007
1008 <td class="type">
1009
1010
1011<span class="param-type">string</span>
1012
1013
1014
1015 </td>
1016
1017
1018 <td class="attributes">
1019
1020
1021
1022 </td>
1023
1024
1025
1026
1027 <td class="description last">Class ID</td>
1028 </tr>
1029
1030
1031
1032 <tr>
1033
1034 <td class="name"><code>num</code></td>
1035
1036
1037 <td class="type">
1038
1039
1040<span class="param-type">number</span>
1041
1042
1043
1044 </td>
1045
1046
1047 <td class="attributes">
1048
1049
1050
1051 </td>
1052
1053
1054
1055
1056 <td class="description last">Index of the class in the dtps.classes array</td>
1057 </tr>
1058
1059
1060
1061 <tr>
1062
1063 <td class="name"><code>subject</code></td>
1064
1065
1066 <td class="type">
1067
1068
1069<span class="param-type">string</span>
1070
1071
1072
1073 </td>
1074
1075
1076 <td class="attributes">
1077
1078
1079
1080 </td>
1081
1082
1083
1084
1085 <td class="description last">Class subject</td>
1086 </tr>
1087
1088
1089
1090 <tr>
1091
1092 <td class="name"><code>assignments</code></td>
1093
1094
1095 <td class="type">
1096
1097
1098<span class="param-type">Array.&lt;<a href="global.html#Assignment">Assignment</a>></span>
1099
1100
1101
1102 </td>
1103
1104
1105 <td class="attributes">
1106
1107
1108
1109 </td>
1110
1111
1112
1113
1114 <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>
1115 </tr>
1116
1117
1118
1119 <tr>
1120
1121 <td class="name"><code>discussions</code></td>
1122
1123
1124 <td class="type">
1125
1126
1127<span class="param-type">Array.&lt;<a href="global.html#DiscussionThread">DiscussionThread</a>></span>
1128|
1129
1130<span class="param-type">boolean</span>
1131
1132
1133
1134 </td>
1135
1136
1137 <td class="attributes">
1138
1139 &lt;optional><br>
1140
1141
1142
1143 </td>
1144
1145
1146
1147
1148 <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>
1149 </tr>
1150
1151
1152
1153 <tr>
1154
1155 <td class="name"><code>pages</code></td>
1156
1157
1158 <td class="type">
1159
1160
1161<span class="param-type">Array.&lt;<a href="global.html#Page">Page</a>></span>
1162|
1163
1164<span class="param-type">boolean</span>
1165
1166
1167
1168 </td>
1169
1170
1171 <td class="attributes">
1172
1173 &lt;optional><br>
1174
1175
1176
1177 </td>
1178
1179
1180
1181
1182 <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>
1183 </tr>
1184
1185
1186
1187 <tr>
1188
1189 <td class="name"><code>newDiscussionThreadURL</code></td>
1190
1191
1192 <td class="type">
1193
1194
1195<span class="param-type">string</span>
1196
1197
1198
1199 </td>
1200
1201
1202 <td class="attributes">
1203
1204 &lt;optional><br>
1205
1206
1207
1208 </td>
1209
1210
1211
1212
1213 <td class="description last">A URL the user can visit to create a new discussion thread in this class</td>
1214 </tr>
1215
1216
1217
1218 <tr>
1219
1220 <td class="name"><code>syllabus</code></td>
1221
1222
1223 <td class="type">
1224
1225
1226<span class="param-type">string</span>
1227
1228
1229
1230 </td>
1231
1232
1233 <td class="attributes">
1234
1235 &lt;optional><br>
1236
1237
1238
1239 </td>
1240
1241
1242
1243
1244 <td class="description last">Class syllabus HTML</td>
1245 </tr>
1246
1247
1248
1249 <tr>
1250
1251 <td class="name"><code>description</code></td>
1252
1253
1254 <td class="type">
1255
1256
1257<span class="param-type">string</span>
1258
1259
1260
1261 </td>
1262
1263
1264 <td class="attributes">
1265
1266 &lt;optional><br>
1267
1268
1269
1270 </td>
1271
1272
1273
1274
1275 <td class="description last">Class description HTML</td>
1276 </tr>
1277
1278
1279
1280 <tr>
1281
1282 <td class="name"><code>numStudents</code></td>
1283
1284
1285 <td class="type">
1286
1287
1288<span class="param-type">number</span>
1289
1290
1291
1292 </td>
1293
1294
1295 <td class="attributes">
1296
1297 &lt;optional><br>
1298
1299
1300
1301 </td>
1302
1303
1304
1305
1306 <td class="description last">Number of students in the class</td>
1307 </tr>
1308
1309
1310
1311 <tr>
1312
1313 <td class="name"><code>term</code></td>
1314
1315
1316 <td class="type">
1317
1318
1319<span class="param-type">string</span>
1320
1321
1322
1323 </td>
1324
1325
1326 <td class="attributes">
1327
1328 &lt;optional><br>
1329
1330
1331
1332 </td>
1333
1334
1335
1336
1337 <td class="description last">Class term</td>
1338 </tr>
1339
1340
1341
1342 <tr>
1343
1344 <td class="name"><code>color</code></td>
1345
1346
1347 <td class="type">
1348
1349
1350<span class="param-type">string</span>
1351
1352
1353
1354 </td>
1355
1356
1357 <td class="attributes">
1358
1359 &lt;optional><br>
1360
1361
1362
1363 </td>
1364
1365
1366
1367
1368 <td class="description last">Class color</td>
1369 </tr>
1370
1371
1372
1373 <tr>
1374
1375 <td class="name"><code>grade</code></td>
1376
1377
1378 <td class="type">
1379
1380
1381<span class="param-type">number</span>
1382
1383
1384
1385 </td>
1386
1387
1388 <td class="attributes">
1389
1390 &lt;optional><br>
1391
1392
1393
1394 </td>
1395
1396
1397
1398
1399 <td class="description last">Current percentage grade in the class</td>
1400 </tr>
1401
1402
1403
1404 <tr>
1405
1406 <td class="name"><code>letter</code></td>
1407
1408
1409 <td class="type">
1410
1411
1412<span class="param-type">string</span>
1413
1414
1415
1416 </td>
1417
1418
1419 <td class="attributes">
1420
1421 &lt;optional><br>
1422
1423
1424
1425 </td>
1426
1427
1428
1429
1430 <td class="description last">Current letter grade in the class</td>
1431 </tr>
1432
1433
1434
1435 <tr>
1436
1437 <td class="name"><code>previousLetter</code></td>
1438
1439
1440 <td class="type">
1441
1442
1443<span class="param-type">string</span>
1444
1445
1446
1447 </td>
1448
1449
1450 <td class="attributes">
1451
1452 &lt;optional><br>
1453
1454
1455
1456 </td>
1457
1458
1459
1460
1461 <td class="description last">Automatically managed by DTPS. The previous letter grade in this class, based on local grade history.</td>
1462 </tr>
1463
1464
1465
1466 <tr>
1467
1468 <td class="name"><code>image</code></td>
1469
1470
1471 <td class="type">
1472
1473
1474<span class="param-type">string</span>
1475
1476
1477
1478 </td>
1479
1480
1481 <td class="attributes">
1482
1483 &lt;optional><br>
1484
1485
1486
1487 </td>
1488
1489
1490
1491
1492 <td class="description last">URL to the class background image</td>
1493 </tr>
1494
1495
1496
1497 <tr>
1498
1499 <td class="name"><code>teacher</code></td>
1500
1501
1502 <td class="type">
1503
1504
1505<span class="param-type"><a href="global.html#User">User</a></span>
1506
1507
1508
1509 </td>
1510
1511
1512 <td class="attributes">
1513
1514 &lt;optional><br>
1515
1516
1517
1518 </td>
1519
1520
1521
1522
1523 <td class="description last">Class teacher</td>
1524 </tr>
1525
1526
1527
1528 <tr>
1529
1530 <td class="name"><code>hasGradebook</code></td>
1531
1532
1533 <td class="type">
1534
1535
1536<span class="param-type">boolean</span>
1537
1538
1539
1540 </td>
1541
1542
1543 <td class="attributes">
1544
1545 &lt;optional><br>
1546
1547
1548
1549 </td>
1550
1551
1552
1553
1554 <td class="description last">Automatically managed by DTPS. True if the class should show the gradebook tab.</td>
1555 </tr>
1556
1557
1558
1559 <tr>
1560
1561 <td class="name"><code>gradeCalculation</code></td>
1562
1563
1564 <td class="type">
1565
1566
1567<span class="param-type">object</span>
1568
1569
1570
1571 </td>
1572
1573
1574 <td class="attributes">
1575
1576 &lt;optional><br>
1577
1578
1579
1580 </td>
1581
1582
1583
1584
1585 <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>
1586 </tr>
1587
1588
1589 </tbody>
1590</table>
1591
1592
1593
1594
1595<dl class="details">
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622 <dt class="tag-source">Source:</dt>
1623 <dd class="tag-source"><ul class="dummy"><li>
1624 <a href="core.js.html">core.js</a>, <a href="core.js.html#line1470">line 1470</a>
1625 </li></ul></dd>
1626
1627
1628
1629
1630
1631
1632
1633</dl>
1634
1635
1636
1637
1638
1639
1640
1641
1642<h4 class="name" id="DashboardItem">DashboardItem</h4>
1643
1644
1645
1646
1647<div class="description">
1648 Defines dashboard items in DTPS
1649</div>
1650
1651
1652
1653 <h5>Type:</h5>
1654 <ul>
1655 <li>
1656
1657<span class="param-type">Object</span>
1658
1659
1660 </li>
1661 </ul>
1662
1663
1664
1665
1666
1667 <h5 class="subsection-title">Properties:</h5>
1668
1669
1670
1671<table class="props">
1672 <thead>
1673 <tr>
1674
1675 <th>Name</th>
1676
1677
1678 <th>Type</th>
1679
1680
1681
1682
1683
1684 <th class="last">Description</th>
1685 </tr>
1686 </thead>
1687
1688 <tbody>
1689
1690
1691 <tr>
1692
1693 <td class="name"><code>name</code></td>
1694
1695
1696 <td class="type">
1697
1698
1699<span class="param-type">string</span>
1700
1701
1702
1703 </td>
1704
1705
1706
1707
1708
1709 <td class="description last">Dashbord item name</td>
1710 </tr>
1711
1712
1713
1714 <tr>
1715
1716 <td class="name"><code>id</code></td>
1717
1718
1719 <td class="type">
1720
1721
1722<span class="param-type">string</span>
1723
1724
1725
1726 </td>
1727
1728
1729
1730
1731
1732 <td class="description last">Unique dashboard item ID</td>
1733 </tr>
1734
1735
1736
1737 <tr>
1738
1739 <td class="name"><code>icon</code></td>
1740
1741
1742 <td class="type">
1743
1744
1745<span class="param-type">string</span>
1746
1747
1748
1749 </td>
1750
1751
1752
1753
1754
1755 <td class="description last">Dashboard item icon</td>
1756 </tr>
1757
1758
1759
1760 <tr>
1761
1762 <td class="name"><code>supportsCompactMode</code></td>
1763
1764
1765 <td class="type">
1766
1767
1768<span class="param-type">boolean</span>
1769
1770
1771
1772 </td>
1773
1774
1775
1776
1777
1778 <td class="description last">True if this dashboard item supports compact mode</td>
1779 </tr>
1780
1781
1782
1783 <tr>
1784
1785 <td class="name"><code>size</code></td>
1786
1787
1788 <td class="type">
1789
1790
1791<span class="param-type">number</span>
1792
1793
1794
1795 </td>
1796
1797
1798
1799
1800
1801 <td class="description last">The approximate size of this dashboard item relative to other dashboard items. Should be no less than 20.</td>
1802 </tr>
1803
1804
1805
1806 <tr>
1807
1808 <td class="name"><code>defaultSide</code></td>
1809
1810
1811 <td class="type">
1812
1813
1814<span class="param-type">string</span>
1815
1816
1817
1818 </td>
1819
1820
1821
1822
1823
1824 <td class="description last">The default side of this dashboard item. Either "right" or "left".</td>
1825 </tr>
1826
1827
1828
1829 <tr>
1830
1831 <td class="name"><code>compact</code></td>
1832
1833
1834 <td class="type">
1835
1836
1837<span class="param-type">boolean</span>
1838
1839
1840
1841 </td>
1842
1843
1844
1845
1846
1847 <td class="description last">True if the user has turned on compact mode for this item.</td>
1848 </tr>
1849
1850
1851 </tbody>
1852</table>
1853
1854
1855
1856
1857<dl class="details">
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884 <dt class="tag-source">Source:</dt>
1885 <dd class="tag-source"><ul class="dummy"><li>
1886 <a href="assignments.js.html">assignments.js</a>, <a href="assignments.js.html#line825">line 825</a>
1887 </li></ul></dd>
1888
1889
1890
1891
1892
1893
1894
1895</dl>
1896
1897
1898
1899
1900
1901
1902
1903
1904<h4 class="name" id="Date">Date</h4>
1905
1906
1907
1908
1909<div class="description">
1910 A date string recognized by <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/parse">Date.parse</a>
1911</div>
1912
1913
1914
1915 <h5>Type:</h5>
1916 <ul>
1917 <li>
1918
1919<span class="param-type">string</span>
1920
1921
1922 </li>
1923 </ul>
1924
1925
1926
1927
1928
1929<dl class="details">
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956 <dt class="tag-source">Source:</dt>
1957 <dd class="tag-source"><ul class="dummy"><li>
1958 <a href="core.js.html">core.js</a>, <a href="core.js.html#line1457">line 1457</a>
1959 </li></ul></dd>
1960
1961
1962
1963
1964
1965
1966
1967</dl>
1968
1969
1970
1971
1972
1973
1974
1975
1976<h4 class="name" id="DiscussionPost">DiscussionPost</h4>
1977
1978
1979
1980
1981<div class="description">
1982 Defines discussion post objects in DTPS
1983</div>
1984
1985
1986
1987 <h5>Type:</h5>
1988 <ul>
1989 <li>
1990
1991<span class="param-type">Object</span>
1992
1993
1994 </li>
1995 </ul>
1996
1997
1998
1999
2000
2001 <h5 class="subsection-title">Properties:</h5>
2002
2003
2004
2005<table class="props">
2006 <thead>
2007 <tr>
2008
2009 <th>Name</th>
2010
2011
2012 <th>Type</th>
2013
2014
2015 <th>Attributes</th>
2016
2017
2018
2019
2020 <th class="last">Description</th>
2021 </tr>
2022 </thead>
2023
2024 <tbody>
2025
2026
2027 <tr>
2028
2029 <td class="name"><code>id</code></td>
2030
2031
2032 <td class="type">
2033
2034
2035<span class="param-type">string</span>
2036
2037
2038
2039 </td>
2040
2041
2042 <td class="attributes">
2043
2044
2045
2046 </td>
2047
2048
2049
2050
2051 <td class="description last">Discussion post ID</td>
2052 </tr>
2053
2054
2055
2056 <tr>
2057
2058 <td class="name"><code>body</code></td>
2059
2060
2061 <td class="type">
2062
2063
2064<span class="param-type">string</span>
2065
2066
2067
2068 </td>
2069
2070
2071 <td class="attributes">
2072
2073
2074
2075 </td>
2076
2077
2078
2079
2080 <td class="description last">Discussion post body HTML</td>
2081 </tr>
2082
2083
2084
2085 <tr>
2086
2087 <td class="name"><code>postedAt</code></td>
2088
2089
2090 <td class="type">
2091
2092
2093<span class="param-type"><a href="global.html#Date">Date</a></span>
2094
2095
2096
2097 </td>
2098
2099
2100 <td class="attributes">
2101
2102
2103
2104 </td>
2105
2106
2107
2108
2109 <td class="description last">Date for when the post was posted</td>
2110 </tr>
2111
2112
2113
2114 <tr>
2115
2116 <td class="name"><code>depth</code></td>
2117
2118
2119 <td class="type">
2120
2121
2122<span class="param-type">number</span>
2123
2124
2125
2126 </td>
2127
2128
2129 <td class="attributes">
2130
2131 &lt;optional><br>
2132
2133
2134
2135 </td>
2136
2137
2138
2139
2140 <td class="description last">The depth level this post is</td>
2141 </tr>
2142
2143
2144
2145 <tr>
2146
2147 <td class="name"><code>author</code></td>
2148
2149
2150 <td class="type">
2151
2152
2153<span class="param-type"><a href="global.html#User">User</a></span>
2154
2155
2156
2157 </td>
2158
2159
2160 <td class="attributes">
2161
2162 &lt;optional><br>
2163
2164
2165
2166 </td>
2167
2168
2169
2170
2171 <td class="description last">Discussion post author</td>
2172 </tr>
2173
2174
2175
2176 <tr>
2177
2178 <td class="name"><code>replies</code></td>
2179
2180
2181 <td class="type">
2182
2183
2184<span class="param-type">Array.&lt;<a href="global.html#DiscussionPost">DiscussionPost</a>></span>
2185
2186
2187
2188 </td>
2189
2190
2191 <td class="attributes">
2192
2193 &lt;optional><br>
2194
2195
2196
2197 </td>
2198
2199
2200
2201
2202 <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>
2203 </tr>
2204
2205
2206
2207 <tr>
2208
2209 <td class="name"><code>replyURL</code></td>
2210
2211
2212 <td class="type">
2213
2214
2215<span class="param-type">string</span>
2216
2217
2218
2219 </td>
2220
2221
2222 <td class="attributes">
2223
2224 &lt;optional><br>
2225
2226
2227
2228 </td>
2229
2230
2231
2232
2233 <td class="description last">A URL that the user can visit to reply to this post</td>
2234 </tr>
2235
2236
2237 </tbody>
2238</table>
2239
2240
2241
2242
2243<dl class="details">
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270 <dt class="tag-source">Source:</dt>
2271 <dd class="tag-source"><ul class="dummy"><li>
2272 <a href="pages-discussions.js.html">pages-discussions.js</a>, <a href="pages-discussions.js.html#line450">line 450</a>
2273 </li></ul></dd>
2274
2275
2276
2277
2278
2279
2280
2281</dl>
2282
2283
2284
2285
2286
2287
2288
2289
2290<h4 class="name" id="DiscussionThread">DiscussionThread</h4>
2291
2292
2293
2294
2295<div class="description">
2296 Defines discussion thread objects in DTPS
2297</div>
2298
2299
2300
2301 <h5>Type:</h5>
2302 <ul>
2303 <li>
2304
2305<span class="param-type">Object</span>
2306
2307
2308 </li>
2309 </ul>
2310
2311
2312
2313
2314
2315 <h5 class="subsection-title">Properties:</h5>
2316
2317
2318
2319<table class="props">
2320 <thead>
2321 <tr>
2322
2323 <th>Name</th>
2324
2325
2326 <th>Type</th>
2327
2328
2329 <th>Attributes</th>
2330
2331
2332
2333
2334 <th class="last">Description</th>
2335 </tr>
2336 </thead>
2337
2338 <tbody>
2339
2340
2341 <tr>
2342
2343 <td class="name"><code>title</code></td>
2344
2345
2346 <td class="type">
2347
2348
2349<span class="param-type">string</span>
2350
2351
2352
2353 </td>
2354
2355
2356 <td class="attributes">
2357
2358
2359
2360 </td>
2361
2362
2363
2364
2365 <td class="description last">Title of the discussion thread</td>
2366 </tr>
2367
2368
2369
2370 <tr>
2371
2372 <td class="name"><code>id</code></td>
2373
2374
2375 <td class="type">
2376
2377
2378<span class="param-type">string</span>
2379
2380
2381
2382 </td>
2383
2384
2385 <td class="attributes">
2386
2387
2388
2389 </td>
2390
2391
2392
2393
2394 <td class="description last">Discussion thread ID</td>
2395 </tr>
2396
2397
2398
2399 <tr>
2400
2401 <td class="name"><code>posts</code></td>
2402
2403
2404 <td class="type">
2405
2406
2407<span class="param-type">Array.&lt;<a href="global.html#DiscussionPost">DiscussionPost</a>></span>
2408
2409
2410
2411 </td>
2412
2413
2414 <td class="attributes">
2415
2416
2417
2418 </td>
2419
2420
2421
2422
2423 <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>
2424 </tr>
2425
2426
2427
2428 <tr>
2429
2430 <td class="name"><code>locked</code></td>
2431
2432
2433 <td class="type">
2434
2435
2436<span class="param-type">boolean</span>
2437
2438
2439
2440 </td>
2441
2442
2443 <td class="attributes">
2444
2445 &lt;optional><br>
2446
2447
2448
2449 </td>
2450
2451
2452
2453
2454 <td class="description last">True if posting to the discussion thread is locked</td>
2455 </tr>
2456
2457
2458
2459 <tr>
2460
2461 <td class="name"><code>requireInitialPost</code></td>
2462
2463
2464 <td class="type">
2465
2466
2467<span class="param-type">boolean</span>
2468
2469
2470
2471 </td>
2472
2473
2474 <td class="attributes">
2475
2476 &lt;optional><br>
2477
2478
2479
2480 </td>
2481
2482
2483
2484
2485 <td class="description last">True if the user must post before viewing others' posts</td>
2486 </tr>
2487
2488
2489 </tbody>
2490</table>
2491
2492
2493
2494
2495<dl class="details">
2496
2497
2498
2499
2500
2501
2502
2503
2504
2505
2506
2507
2508
2509
2510
2511
2512
2513
2514
2515
2516
2517
2518
2519
2520
2521
2522 <dt class="tag-source">Source:</dt>
2523 <dd class="tag-source"><ul class="dummy"><li>
2524 <a href="pages-discussions.js.html">pages-discussions.js</a>, <a href="pages-discussions.js.html#line440">line 440</a>
2525 </li></ul></dd>
2526
2527
2528
2529
2530
2531
2532
2533</dl>
2534
2535
2536
2537
2538
2539
2540
2541
2542<h4 class="name" id="Page">Page</h4>
2543
2544
2545
2546
2547<div class="description">
2548 Defines Page objects in DTPS
2549</div>
2550
2551
2552
2553 <h5>Type:</h5>
2554 <ul>
2555 <li>
2556
2557<span class="param-type">Object</span>
2558
2559
2560 </li>
2561 </ul>
2562
2563
2564
2565
2566
2567 <h5 class="subsection-title">Properties:</h5>
2568
2569
2570
2571<table class="props">
2572 <thead>
2573 <tr>
2574
2575 <th>Name</th>
2576
2577
2578 <th>Type</th>
2579
2580
2581 <th>Attributes</th>
2582
2583
2584
2585
2586 <th class="last">Description</th>
2587 </tr>
2588 </thead>
2589
2590 <tbody>
2591
2592
2593 <tr>
2594
2595 <td class="name"><code>title</code></td>
2596
2597
2598 <td class="type">
2599
2600
2601<span class="param-type">string</span>
2602
2603
2604
2605 </td>
2606
2607
2608 <td class="attributes">
2609
2610
2611
2612 </td>
2613
2614
2615
2616
2617 <td class="description last">Page title</td>
2618 </tr>
2619
2620
2621
2622 <tr>
2623
2624 <td class="name"><code>id</code></td>
2625
2626
2627 <td class="type">
2628
2629
2630<span class="param-type">string</span>
2631
2632
2633
2634 </td>
2635
2636
2637 <td class="attributes">
2638
2639
2640
2641 </td>
2642
2643
2644
2645
2646 <td class="description last">Page ID</td>
2647 </tr>
2648
2649
2650
2651 <tr>
2652
2653 <td class="name"><code>content</code></td>
2654
2655
2656 <td class="type">
2657
2658
2659<span class="param-type">string</span>
2660
2661
2662
2663 </td>
2664
2665
2666 <td class="attributes">
2667
2668
2669
2670 </td>
2671
2672
2673
2674
2675 <td class="description last">Page content. Assume the page hasn't been selected/loaded if this is undefined.</td>
2676 </tr>
2677
2678
2679
2680 <tr>
2681
2682 <td class="name"><code>updatedAt</code></td>
2683
2684
2685 <td class="type">
2686
2687
2688<span class="param-type"><a href="global.html#Date">Date</a></span>
2689
2690
2691
2692 </td>
2693
2694
2695 <td class="attributes">
2696
2697 &lt;optional><br>
2698
2699
2700
2701 </td>
2702
2703
2704
2705
2706 <td class="description last">When the page was last updated</td>
2707 </tr>
2708
2709
2710
2711 <tr>
2712
2713 <td class="name"><code>author</code></td>
2714
2715
2716 <td class="type">
2717
2718
2719<span class="param-type"><a href="global.html#User">User</a></span>
2720
2721
2722
2723 </td>
2724
2725
2726 <td class="attributes">
2727
2728 &lt;optional><br>
2729
2730
2731
2732 </td>
2733
2734
2735
2736
2737 <td class="description last">Page author</td>
2738 </tr>
2739
2740
2741 </tbody>
2742</table>
2743
2744
2745
2746
2747<dl class="details">
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774 <dt class="tag-source">Source:</dt>
2775 <dd class="tag-source"><ul class="dummy"><li>
2776 <a href="pages-discussions.js.html">pages-discussions.js</a>, <a href="pages-discussions.js.html#line462">line 462</a>
2777 </li></ul></dd>
2778
2779
2780
2781
2782
2783
2784
2785</dl>
2786
2787
2788
2789
2790
2791
2792
2793
2794<h4 class="name" id="RubricItem">RubricItem</h4>
2795
2796
2797
2798
2799<div class="description">
2800 Defines rubric item objects in DTPS
2801</div>
2802
2803
2804
2805 <h5>Type:</h5>
2806 <ul>
2807 <li>
2808
2809<span class="param-type">Object</span>
2810
2811
2812 </li>
2813 </ul>
2814
2815
2816
2817
2818
2819 <h5 class="subsection-title">Properties:</h5>
2820
2821
2822
2823<table class="props">
2824 <thead>
2825 <tr>
2826
2827 <th>Name</th>
2828
2829
2830 <th>Type</th>
2831
2832
2833 <th>Attributes</th>
2834
2835
2836
2837
2838 <th class="last">Description</th>
2839 </tr>
2840 </thead>
2841
2842 <tbody>
2843
2844
2845 <tr>
2846
2847 <td class="name"><code>title</code></td>
2848
2849
2850 <td class="type">
2851
2852
2853<span class="param-type">string</span>
2854
2855
2856
2857 </td>
2858
2859
2860 <td class="attributes">
2861
2862
2863
2864 </td>
2865
2866
2867
2868
2869 <td class="description last">Title of the rubric item</td>
2870 </tr>
2871
2872
2873
2874 <tr>
2875
2876 <td class="name"><code>id</code></td>
2877
2878
2879 <td class="type">
2880
2881
2882<span class="param-type">string</span>
2883
2884
2885
2886 </td>
2887
2888
2889 <td class="attributes">
2890
2891
2892
2893 </td>
2894
2895
2896
2897
2898 <td class="description last">Rubric item ID (does NOT have to be unique)</td>
2899 </tr>
2900
2901
2902
2903 <tr>
2904
2905 <td class="name"><code>value</code></td>
2906
2907
2908 <td class="type">
2909
2910
2911<span class="param-type">number</span>
2912
2913
2914
2915 </td>
2916
2917
2918 <td class="attributes">
2919
2920
2921
2922 </td>
2923
2924
2925
2926
2927 <td class="description last">Total amount of points possible</td>
2928 </tr>
2929
2930
2931
2932 <tr>
2933
2934 <td class="name"><code>outcome</code></td>
2935
2936
2937 <td class="type">
2938
2939
2940<span class="param-type">string</span>
2941
2942
2943
2944 </td>
2945
2946
2947 <td class="attributes">
2948
2949 &lt;optional><br>
2950
2951
2952
2953 </td>
2954
2955
2956
2957
2958 <td class="description last">The ID of the outcome this rubric item is assessing. This is only used for grade calculation.</td>
2959 </tr>
2960
2961
2962
2963 <tr>
2964
2965 <td class="name"><code>description</code></td>
2966
2967
2968 <td class="type">
2969
2970
2971<span class="param-type">string</span>
2972
2973
2974
2975 </td>
2976
2977
2978 <td class="attributes">
2979
2980 &lt;optional><br>
2981
2982
2983
2984 </td>
2985
2986
2987
2988
2989 <td class="description last">Rubric item description</td>
2990 </tr>
2991
2992
2993
2994 <tr>
2995
2996 <td class="name"><code>score</code></td>
2997
2998
2999 <td class="type">
3000
3001
3002<span class="param-type">number</span>
3003
3004
3005
3006 </td>
3007
3008
3009 <td class="attributes">
3010
3011 &lt;optional><br>
3012
3013
3014
3015 </td>
3016
3017
3018
3019
3020 <td class="description last">Rubric assessment score in points</td>
3021 </tr>
3022
3023
3024
3025 <tr>
3026
3027 <td class="name"><code>scoreName</code></td>
3028
3029
3030 <td class="type">
3031
3032
3033<span class="param-type">string</span>
3034
3035
3036
3037 </td>
3038
3039
3040 <td class="attributes">
3041
3042 &lt;optional><br>
3043
3044
3045
3046 </td>
3047
3048
3049
3050
3051 <td class="description last">Rubric assessment score name</td>
3052 </tr>
3053
3054
3055
3056 <tr>
3057
3058 <td class="name"><code>scoreColor</code></td>
3059
3060
3061 <td class="type">
3062
3063
3064<span class="param-type">string</span>
3065
3066
3067
3068 </td>
3069
3070
3071 <td class="attributes">
3072
3073 &lt;optional><br>
3074
3075
3076
3077 </td>
3078
3079
3080
3081
3082 <td class="description last">Score color in CSS color format</td>
3083 </tr>
3084
3085
3086 </tbody>
3087</table>
3088
3089
3090
3091
3092<dl class="details">
3093
3094
3095
3096
3097
3098
3099
3100
3101
3102
3103
3104
3105
3106
3107
3108
3109
3110
3111
3112
3113
3114
3115
3116
3117
3118
3119 <dt class="tag-source">Source:</dt>
3120 <dd class="tag-source"><ul class="dummy"><li>
3121 <a href="assignments.js.html">assignments.js</a>, <a href="assignments.js.html#line812">line 812</a>
3122 </li></ul></dd>
3123
3124
3125
3126
3127
3128
3129
3130</dl>
3131
3132
3133
3134
3135
3136
3137
3138
3139<h4 class="name" id="User">User</h4>
3140
3141
3142
3143
3144<div class="description">
3145 Defines user objects in DTPS
3146</div>
3147
3148
3149
3150 <h5>Type:</h5>
3151 <ul>
3152 <li>
3153
3154<span class="param-type">Object</span>
3155
3156
3157 </li>
3158 </ul>
3159
3160
3161
3162
3163
3164 <h5 class="subsection-title">Properties:</h5>
3165
3166
3167
3168<table class="props">
3169 <thead>
3170 <tr>
3171
3172 <th>Name</th>
3173
3174
3175 <th>Type</th>
3176
3177
3178
3179
3180
3181 <th class="last">Description</th>
3182 </tr>
3183 </thead>
3184
3185 <tbody>
3186
3187
3188 <tr>
3189
3190 <td class="name"><code>name</code></td>
3191
3192
3193 <td class="type">
3194
3195
3196<span class="param-type">string</span>
3197
3198
3199
3200 </td>
3201
3202
3203
3204
3205
3206 <td class="description last">User name</td>
3207 </tr>
3208
3209
3210
3211 <tr>
3212
3213 <td class="name"><code>id</code></td>
3214
3215
3216 <td class="type">
3217
3218
3219<span class="param-type">string</span>
3220
3221
3222
3223 </td>
3224
3225
3226
3227
3228
3229 <td class="description last">User ID</td>
3230 </tr>
3231
3232
3233
3234 <tr>
3235
3236 <td class="name"><code>photoURL</code></td>
3237
3238
3239 <td class="type">
3240
3241
3242<span class="param-type">string</span>
3243
3244
3245
3246 </td>
3247
3248
3249
3250
3251
3252 <td class="description last">User photo URL</td>
3253 </tr>
3254
3255
3256 </tbody>
3257</table>
3258
3259
3260
3261
3262<dl class="details">
3263
3264
3265
3266
3267
3268
3269
3270
3271
3272
3273
3274
3275
3276
3277
3278
3279
3280
3281
3282
3283
3284
3285
3286
3287
3288
3289 <dt class="tag-source">Source:</dt>
3290 <dd class="tag-source"><ul class="dummy"><li>
3291 <a href="core.js.html">core.js</a>, <a href="core.js.html#line1462">line 1462</a>
3292 </li></ul></dd>
3293
3294
3295
3296
3297
3298
3299
3300</dl>
3301
3302
3303
3304
3305
3306
3307
3308
3309
3310
3311</article>
3312
3313</section>
3314
3315
3316
3317
3318</div>
3319
3320<nav>
3321 <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>
3322</nav>
3323
3324<br class="clear">
3325
3326<footer>
3327 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)
3328</footer>
3329
3330<script> prettyPrint(); </script>
3331<script src="scripts/linenumber.js"> </script>
3332</body>
3333</html>