| <!DOCTYPE html> |
| <html lang="en"> |
| <head> |
| <meta charset="utf-8"> |
| <title>JSDoc: Global</title> |
| |
| <script src="scripts/prettify/prettify.js"> </script> |
| <script src="scripts/prettify/lang-css.js"> </script> |
| <!--[if lt IE 9]> |
| <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script> |
| <![endif]--> |
| <link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css"> |
| <link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css"> |
| </head> |
| |
| <body> |
| |
| <div id="main"> |
| |
| <h1 class="page-title">Global</h1> |
| |
| |
| |
| |
| |
| |
| <section> |
| |
| <header> |
| |
| <h2></h2> |
| |
| |
| </header> |
| |
| <article> |
| <div class="container-overview"> |
| |
| |
| |
| |
| |
| |
| <dl class="details"> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </dl> |
| |
| |
| |
| |
| </div> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <h3 class="subsection-title">Type Definitions</h3> |
| |
| |
| |
| <h4 class="name" id="Announcement">Announcement</h4> |
| |
| |
| |
| |
| <div class="description"> |
| Defines announcement objects in DTPS |
| </div> |
| |
| |
| |
| <h5>Type:</h5> |
| <ul> |
| <li> |
| |
| <span class="param-type">Object</span> |
| |
| |
| </li> |
| </ul> |
| |
| |
| |
| |
| |
| <h5 class="subsection-title">Properties:</h5> |
| |
| |
| |
| <table class="props"> |
| <thead> |
| <tr> |
| |
| <th>Name</th> |
| |
| |
| <th>Type</th> |
| |
| |
| |
| |
| |
| <th class="last">Description</th> |
| </tr> |
| </thead> |
| |
| <tbody> |
| |
| |
| <tr> |
| |
| <td class="name"><code>title</code></td> |
| |
| |
| <td class="type"> |
| |
| |
| <span class="param-type">string</span> |
| |
| |
| |
| </td> |
| |
| |
| |
| |
| |
| <td class="description last">Title of the announcement</td> |
| </tr> |
| |
| |
| |
| <tr> |
| |
| <td class="name"><code>postedAt</code></td> |
| |
| |
| <td class="type"> |
| |
| |
| <span class="param-type"><a href="global.html#Date">Date</a></span> |
| |
| |
| |
| </td> |
| |
| |
| |
| |
| |
| <td class="description last">Date when the announcement was posted</td> |
| </tr> |
| |
| |
| |
| <tr> |
| |
| <td class="name"><code>body</code></td> |
| |
| |
| <td class="type"> |
| |
| |
| <span class="param-type">string</span> |
| |
| |
| |
| </td> |
| |
| |
| |
| |
| |
| <td class="description last">Announcement content</td> |
| </tr> |
| |
| |
| </tbody> |
| </table> |
| |
| |
| |
| |
| <dl class="details"> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <dt class="tag-source">Source:</dt> |
| <dd class="tag-source"><ul class="dummy"><li> |
| <a href="assignments.js.html">assignments.js</a>, <a href="assignments.js.html#line1024">line 1024</a> |
| </li></ul></dd> |
| |
| |
| |
| |
| |
| |
| |
| </dl> |
| |
| |
| |
| |
| |
| |
| |
| |
| <h4 class="name" id="Assignment">Assignment</h4> |
| |
| |
| |
| |
| <div class="description"> |
| Defines assignments objects in DTPS |
| </div> |
| |
| |
| |
| <h5>Type:</h5> |
| <ul> |
| <li> |
| |
| <span class="param-type">Object</span> |
| |
| |
| </li> |
| </ul> |
| |
| |
| |
| |
| |
| <h5 class="subsection-title">Properties:</h5> |
| |
| |
| |
| <table class="props"> |
| <thead> |
| <tr> |
| |
| <th>Name</th> |
| |
| |
| <th>Type</th> |
| |
| |
| <th>Attributes</th> |
| |
| |
| |
| |
| <th class="last">Description</th> |
| </tr> |
| </thead> |
| |
| <tbody> |
| |
| |
| <tr> |
| |
| <td class="name"><code>title</code></td> |
| |
| |
| <td class="type"> |
| |
| |
| <span class="param-type">string</span> |
| |
| |
| |
| </td> |
| |
| |
| <td class="attributes"> |
| |
| |
| |
| </td> |
| |
| |
| |
| |
| <td class="description last">Title of the assignment</td> |
| </tr> |
| |
| |
| |
| <tr> |
| |
| <td class="name"><code>body</code></td> |
| |
| |
| <td class="type"> |
| |
| |
| <span class="param-type">string</span> |
| |
| |
| |
| </td> |
| |
| |
| <td class="attributes"> |
| |
| <optional><br> |
| |
| |
| |
| </td> |
| |
| |
| |
| |
| <td class="description last">HTML of the assignment's body</td> |
| </tr> |
| |
| |
| |
| <tr> |
| |
| <td class="name"><code>id</code></td> |
| |
| |
| <td class="type"> |
| |
| |
| <span class="param-type">string</span> |
| |
| |
| |
| </td> |
| |
| |
| <td class="attributes"> |
| |
| |
| |
| </td> |
| |
| |
| |
| |
| <td class="description last">Assignment ID</td> |
| </tr> |
| |
| |
| |
| <tr> |
| |
| <td class="name"><code>dueAt</code></td> |
| |
| |
| <td class="type"> |
| |
| |
| <span class="param-type"><a href="global.html#Date">Date</a></span> |
| |
| |
| |
| </td> |
| |
| |
| <td class="attributes"> |
| |
| <optional><br> |
| |
| |
| |
| </td> |
| |
| |
| |
| |
| <td class="description last">Assignment due date</td> |
| </tr> |
| |
| |
| |
| <tr> |
| |
| <td class="name"><code>url</code></td> |
| |
| |
| <td class="type"> |
| |
| |
| <span class="param-type">string</span> |
| |
| |
| |
| </td> |
| |
| |
| <td class="attributes"> |
| |
| |
| |
| </td> |
| |
| |
| |
| |
| <td class="description last">Assignment URL</td> |
| </tr> |
| |
| |
| |
| <tr> |
| |
| <td class="name"><code>feedback</code></td> |
| |
| |
| <td class="type"> |
| |
| |
| <span class="param-type">Array.<<a href="global.html#AssignmentFeedback">AssignmentFeedback</a>></span> |
| |
| |
| |
| </td> |
| |
| |
| <td class="attributes"> |
| |
| <optional><br> |
| |
| |
| |
| </td> |
| |
| |
| |
| |
| <td class="description last">Feedback / private comments for this assignment</td> |
| </tr> |
| |
| |
| |
| <tr> |
| |
| <td class="name"><code>grader</code></td> |
| |
| |
| <td class="type"> |
| |
| |
| <span class="param-type"><a href="global.html#User">User</a></span> |
| |
| |
| |
| </td> |
| |
| |
| <td class="attributes"> |
| |
| <optional><br> |
| |
| |
| |
| </td> |
| |
| |
| |
| |
| <td class="description last">Assignment grader</td> |
| </tr> |
| |
| |
| |
| <tr> |
| |
| <td class="name"><code>turnedIn</code></td> |
| |
| |
| <td class="type"> |
| |
| |
| <span class="param-type">boolean</span> |
| |
| |
| |
| </td> |
| |
| |
| <td class="attributes"> |
| |
| <optional><br> |
| |
| |
| |
| </td> |
| |
| |
| |
| |
| <td class="description last">True if the assignment is turned in</td> |
| </tr> |
| |
| |
| |
| <tr> |
| |
| <td class="name"><code>late</code></td> |
| |
| |
| <td class="type"> |
| |
| |
| <span class="param-type">boolean</span> |
| |
| |
| |
| </td> |
| |
| |
| <td class="attributes"> |
| |
| <optional><br> |
| |
| |
| |
| </td> |
| |
| |
| |
| |
| <td class="description last">True if the assignment is late</td> |
| </tr> |
| |
| |
| |
| <tr> |
| |
| <td class="name"><code>missing</code></td> |
| |
| |
| <td class="type"> |
| |
| |
| <span class="param-type">boolean</span> |
| |
| |
| |
| </td> |
| |
| |
| <td class="attributes"> |
| |
| <optional><br> |
| |
| |
| |
| </td> |
| |
| |
| |
| |
| <td class="description last">True if the assignment is missing</td> |
| </tr> |
| |
| |
| |
| <tr> |
| |
| <td class="name"><code>locked</code></td> |
| |
| |
| <td class="type"> |
| |
| |
| <span class="param-type">boolean</span> |
| |
| |
| |
| </td> |
| |
| |
| <td class="attributes"> |
| |
| <optional><br> |
| |
| |
| |
| </td> |
| |
| |
| |
| |
| <td class="description last">True if assignment submissions are locked</td> |
| </tr> |
| |
| |
| |
| <tr> |
| |
| <td class="name"><code>category</code></td> |
| |
| |
| <td class="type"> |
| |
| |
| <span class="param-type">string</span> |
| |
| |
| |
| </td> |
| |
| |
| <td class="attributes"> |
| |
| <optional><br> |
| |
| |
| |
| </td> |
| |
| |
| |
| |
| <td class="description last">Assignment category</td> |
| </tr> |
| |
| |
| |
| <tr> |
| |
| <td class="name"><code>publishedAt</code></td> |
| |
| |
| <td class="type"> |
| |
| |
| <span class="param-type"><a href="global.html#Date">Date</a></span> |
| |
| |
| |
| </td> |
| |
| |
| <td class="attributes"> |
| |
| <optional><br> |
| |
| |
| |
| </td> |
| |
| |
| |
| |
| <td class="description last">Date for when the assignment was published</td> |
| </tr> |
| |
| |
| |
| <tr> |
| |
| <td class="name"><code>gradedAt</code></td> |
| |
| |
| <td class="type"> |
| |
| |
| <span class="param-type"><a href="global.html#Date">Date</a></span> |
| |
| |
| |
| </td> |
| |
| |
| <td class="attributes"> |
| |
| <optional><br> |
| |
| |
| |
| </td> |
| |
| |
| |
| |
| <td class="description last">Date for when the assignment was graded</td> |
| </tr> |
| |
| |
| |
| <tr> |
| |
| <td class="name"><code>grade</code></td> |
| |
| |
| <td class="type"> |
| |
| |
| <span class="param-type">number</span> |
| |
| |
| |
| </td> |
| |
| |
| <td class="attributes"> |
| |
| <optional><br> |
| |
| |
| |
| </td> |
| |
| |
| |
| |
| <td class="description last">Points earned on this assignment</td> |
| </tr> |
| |
| |
| |
| <tr> |
| |
| <td class="name"><code>letter</code></td> |
| |
| |
| <td class="type"> |
| |
| |
| <span class="param-type">string</span> |
| |
| |
| |
| </td> |
| |
| |
| <td class="attributes"> |
| |
| <optional><br> |
| |
| |
| |
| </td> |
| |
| |
| |
| |
| <td class="description last">Letter grade on this assignment</td> |
| </tr> |
| |
| |
| |
| <tr> |
| |
| <td class="name"><code>value</code></td> |
| |
| |
| <td class="type"> |
| |
| |
| <span class="param-type">number</span> |
| |
| |
| |
| </td> |
| |
| |
| <td class="attributes"> |
| |
| <optional><br> |
| |
| |
| |
| </td> |
| |
| |
| |
| |
| <td class="description last">Total amount of points possible for this assignment</td> |
| </tr> |
| |
| |
| |
| <tr> |
| |
| <td class="name"><code>rubric</code></td> |
| |
| |
| <td class="type"> |
| |
| |
| <span class="param-type">Array.<<a href="global.html#RubricItem">RubricItem</a>></span> |
| |
| |
| |
| </td> |
| |
| |
| <td class="attributes"> |
| |
| <optional><br> |
| |
| |
| |
| </td> |
| |
| |
| |
| |
| <td class="description last">Assignment rubric</td> |
| </tr> |
| |
| |
| </tbody> |
| </table> |
| |
| |
| |
| |
| <dl class="details"> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <dt class="tag-source">Source:</dt> |
| <dd class="tag-source"><ul class="dummy"><li> |
| <a href="assignments.js.html">assignments.js</a>, <a href="assignments.js.html#line982">line 982</a> |
| </li></ul></dd> |
| |
| |
| |
| |
| |
| |
| |
| </dl> |
| |
| |
| |
| |
| |
| |
| |
| |
| <h4 class="name" id="AssignmentFeedback">AssignmentFeedback</h4> |
| |
| |
| |
| |
| <div class="description"> |
| Defines assignment feedback objects in DTPS |
| </div> |
| |
| |
| |
| <h5>Type:</h5> |
| <ul> |
| <li> |
| |
| <span class="param-type">Object</span> |
| |
| |
| </li> |
| </ul> |
| |
| |
| |
| |
| |
| <h5 class="subsection-title">Properties:</h5> |
| |
| |
| |
| <table class="props"> |
| <thead> |
| <tr> |
| |
| <th>Name</th> |
| |
| |
| <th>Type</th> |
| |
| |
| <th>Attributes</th> |
| |
| |
| |
| |
| <th class="last">Description</th> |
| </tr> |
| </thead> |
| |
| <tbody> |
| |
| |
| <tr> |
| |
| <td class="name"><code>comment</code></td> |
| |
| |
| <td class="type"> |
| |
| |
| <span class="param-type">string</span> |
| |
| |
| |
| </td> |
| |
| |
| <td class="attributes"> |
| |
| |
| |
| </td> |
| |
| |
| |
| |
| <td class="description last">Feedback comment</td> |
| </tr> |
| |
| |
| |
| <tr> |
| |
| <td class="name"><code>author</code></td> |
| |
| |
| <td class="type"> |
| |
| |
| <span class="param-type"><a href="global.html#User">User</a></span> |
| |
| |
| |
| </td> |
| |
| |
| <td class="attributes"> |
| |
| <optional><br> |
| |
| |
| |
| </td> |
| |
| |
| |
| |
| <td class="description last">Feedback author</td> |
| </tr> |
| |
| |
| </tbody> |
| </table> |
| |
| |
| |
| |
| <dl class="details"> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <dt class="tag-source">Source:</dt> |
| <dd class="tag-source"><ul class="dummy"><li> |
| <a href="assignments.js.html">assignments.js</a>, <a href="assignments.js.html#line1032">line 1032</a> |
| </li></ul></dd> |
| |
| |
| |
| |
| |
| |
| |
| </dl> |
| |
| |
| |
| |
| |
| |
| |
| |
| <h4 class="name" id="Class">Class</h4> |
| |
| |
| |
| |
| <div class="description"> |
| Defines class objects in DTPS |
| </div> |
| |
| |
| |
| <h5>Type:</h5> |
| <ul> |
| <li> |
| |
| <span class="param-type">Object</span> |
| |
| |
| </li> |
| </ul> |
| |
| |
| |
| |
| |
| <h5 class="subsection-title">Properties:</h5> |
| |
| |
| |
| <table class="props"> |
| <thead> |
| <tr> |
| |
| <th>Name</th> |
| |
| |
| <th>Type</th> |
| |
| |
| <th>Attributes</th> |
| |
| |
| |
| |
| <th class="last">Description</th> |
| </tr> |
| </thead> |
| |
| <tbody> |
| |
| |
| <tr> |
| |
| <td class="name"><code>name</code></td> |
| |
| |
| <td class="type"> |
| |
| |
| <span class="param-type">string</span> |
| |
| |
| |
| </td> |
| |
| |
| <td class="attributes"> |
| |
| |
| |
| </td> |
| |
| |
| |
| |
| <td class="description last">Name of the class</td> |
| </tr> |
| |
| |
| |
| <tr> |
| |
| <td class="name"><code>id</code></td> |
| |
| |
| <td class="type"> |
| |
| |
| <span class="param-type">string</span> |
| |
| |
| |
| </td> |
| |
| |
| <td class="attributes"> |
| |
| |
| |
| </td> |
| |
| |
| |
| |
| <td class="description last">Class ID</td> |
| </tr> |
| |
| |
| |
| <tr> |
| |
| <td class="name"><code>num</code></td> |
| |
| |
| <td class="type"> |
| |
| |
| <span class="param-type">number</span> |
| |
| |
| |
| </td> |
| |
| |
| <td class="attributes"> |
| |
| |
| |
| </td> |
| |
| |
| |
| |
| <td class="description last">Index of the class in the dtps.classes array</td> |
| </tr> |
| |
| |
| |
| <tr> |
| |
| <td class="name"><code>subject</code></td> |
| |
| |
| <td class="type"> |
| |
| |
| <span class="param-type">string</span> |
| |
| |
| |
| </td> |
| |
| |
| <td class="attributes"> |
| |
| |
| |
| </td> |
| |
| |
| |
| |
| <td class="description last">Class subject</td> |
| </tr> |
| |
| |
| |
| <tr> |
| |
| <td class="name"><code>assignments</code></td> |
| |
| |
| <td class="type"> |
| |
| |
| <span class="param-type">Array.<<a href="global.html#Assignment">Assignment</a>></span> |
| |
| |
| |
| </td> |
| |
| |
| <td class="attributes"> |
| |
| |
| |
| </td> |
| |
| |
| |
| |
| <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> |
| </tr> |
| |
| |
| |
| <tr> |
| |
| <td class="name"><code>modules</code></td> |
| |
| |
| <td class="type"> |
| |
| |
| <span class="param-type">Array.<<a href="global.html#Module">Module</a>></span> |
| | |
| |
| <span class="param-type">boolean</span> |
| |
| |
| |
| </td> |
| |
| |
| <td class="attributes"> |
| |
| <optional><br> |
| |
| |
| |
| </td> |
| |
| |
| |
| |
| <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> |
| </tr> |
| |
| |
| |
| <tr> |
| |
| <td class="name"><code>discussions</code></td> |
| |
| |
| <td class="type"> |
| |
| |
| <span class="param-type">Array.<<a href="global.html#DiscussionThread">DiscussionThread</a>></span> |
| | |
| |
| <span class="param-type">boolean</span> |
| |
| |
| |
| </td> |
| |
| |
| <td class="attributes"> |
| |
| <optional><br> |
| |
| |
| |
| </td> |
| |
| |
| |
| |
| <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> |
| </tr> |
| |
| |
| |
| <tr> |
| |
| <td class="name"><code>pages</code></td> |
| |
| |
| <td class="type"> |
| |
| |
| <span class="param-type">Array.<<a href="global.html#Page">Page</a>></span> |
| | |
| |
| <span class="param-type">boolean</span> |
| |
| |
| |
| </td> |
| |
| |
| <td class="attributes"> |
| |
| <optional><br> |
| |
| |
| |
| </td> |
| |
| |
| |
| |
| <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> |
| </tr> |
| |
| |
| |
| <tr> |
| |
| <td class="name"><code>newDiscussionThreadURL</code></td> |
| |
| |
| <td class="type"> |
| |
| |
| <span class="param-type">string</span> |
| |
| |
| |
| </td> |
| |
| |
| <td class="attributes"> |
| |
| <optional><br> |
| |
| |
| |
| </td> |
| |
| |
| |
| |
| <td class="description last">A URL the user can visit to create a new discussion thread in this class</td> |
| </tr> |
| |
| |
| |
| <tr> |
| |
| <td class="name"><code>syllabus</code></td> |
| |
| |
| <td class="type"> |
| |
| |
| <span class="param-type">string</span> |
| |
| |
| |
| </td> |
| |
| |
| <td class="attributes"> |
| |
| <optional><br> |
| |
| |
| |
| </td> |
| |
| |
| |
| |
| <td class="description last">Class syllabus HTML</td> |
| </tr> |
| |
| |
| |
| <tr> |
| |
| <td class="name"><code>homepage</code></td> |
| |
| |
| <td class="type"> |
| |
| |
| <span class="param-type">boolean</span> |
| |
| |
| |
| </td> |
| |
| |
| <td class="attributes"> |
| |
| <optional><br> |
| |
| |
| |
| </td> |
| |
| |
| |
| |
| <td class="description last">True if the class has a homepage. If a class has a homepage, dtpsLMS.fetchHomepage must be implemented.</td> |
| </tr> |
| |
| |
| |
| <tr> |
| |
| <td class="name"><code>description</code></td> |
| |
| |
| <td class="type"> |
| |
| |
| <span class="param-type">string</span> |
| |
| |
| |
| </td> |
| |
| |
| <td class="attributes"> |
| |
| <optional><br> |
| |
| |
| |
| </td> |
| |
| |
| |
| |
| <td class="description last">Class description HTML</td> |
| </tr> |
| |
| |
| |
| <tr> |
| |
| <td class="name"><code>numStudents</code></td> |
| |
| |
| <td class="type"> |
| |
| |
| <span class="param-type">number</span> |
| |
| |
| |
| </td> |
| |
| |
| <td class="attributes"> |
| |
| <optional><br> |
| |
| |
| |
| </td> |
| |
| |
| |
| |
| <td class="description last">Number of students in the class</td> |
| </tr> |
| |
| |
| |
| <tr> |
| |
| <td class="name"><code>term</code></td> |
| |
| |
| <td class="type"> |
| |
| |
| <span class="param-type">string</span> |
| |
| |
| |
| </td> |
| |
| |
| <td class="attributes"> |
| |
| <optional><br> |
| |
| |
| |
| </td> |
| |
| |
| |
| |
| <td class="description last">Class term</td> |
| </tr> |
| |
| |
| |
| <tr> |
| |
| <td class="name"><code>color</code></td> |
| |
| |
| <td class="type"> |
| |
| |
| <span class="param-type">string</span> |
| |
| |
| |
| </td> |
| |
| |
| <td class="attributes"> |
| |
| <optional><br> |
| |
| |
| |
| </td> |
| |
| |
| |
| |
| <td class="description last">Class color</td> |
| </tr> |
| |
| |
| |
| <tr> |
| |
| <td class="name"><code>grade</code></td> |
| |
| |
| <td class="type"> |
| |
| |
| <span class="param-type">number</span> |
| |
| |
| |
| </td> |
| |
| |
| <td class="attributes"> |
| |
| <optional><br> |
| |
| |
| |
| </td> |
| |
| |
| |
| |
| <td class="description last">Current percentage grade in the class</td> |
| </tr> |
| |
| |
| |
| <tr> |
| |
| <td class="name"><code>letter</code></td> |
| |
| |
| <td class="type"> |
| |
| |
| <span class="param-type">string</span> |
| |
| |
| |
| </td> |
| |
| |
| <td class="attributes"> |
| |
| <optional><br> |
| |
| |
| |
| </td> |
| |
| |
| |
| |
| <td class="description last">Current letter grade in the class</td> |
| </tr> |
| |
| |
| |
| <tr> |
| |
| <td class="name"><code>previousLetter</code></td> |
| |
| |
| <td class="type"> |
| |
| |
| <span class="param-type">string</span> |
| |
| |
| |
| </td> |
| |
| |
| <td class="attributes"> |
| |
| <optional><br> |
| |
| |
| |
| </td> |
| |
| |
| |
| |
| <td class="description last">Automatically managed by DTPS. The previous letter grade in this class, based on local grade history.</td> |
| </tr> |
| |
| |
| |
| <tr> |
| |
| <td class="name"><code>image</code></td> |
| |
| |
| <td class="type"> |
| |
| |
| <span class="param-type">string</span> |
| |
| |
| |
| </td> |
| |
| |
| <td class="attributes"> |
| |
| <optional><br> |
| |
| |
| |
| </td> |
| |
| |
| |
| |
| <td class="description last">URL to the class background image</td> |
| </tr> |
| |
| |
| |
| <tr> |
| |
| <td class="name"><code>teacher</code></td> |
| |
| |
| <td class="type"> |
| |
| |
| <span class="param-type"><a href="global.html#User">User</a></span> |
| |
| |
| |
| </td> |
| |
| |
| <td class="attributes"> |
| |
| <optional><br> |
| |
| |
| |
| </td> |
| |
| |
| |
| |
| <td class="description last">Class teacher</td> |
| </tr> |
| |
| |
| |
| <tr> |
| |
| <td class="name"><code>hasGradebook</code></td> |
| |
| |
| <td class="type"> |
| |
| |
| <span class="param-type">boolean</span> |
| |
| |
| |
| </td> |
| |
| |
| <td class="attributes"> |
| |
| <optional><br> |
| |
| |
| |
| </td> |
| |
| |
| |
| |
| <td class="description last">Automatically managed by DTPS. True if the class should show the gradebook tab.</td> |
| </tr> |
| |
| |
| |
| <tr> |
| |
| <td class="name"><code>gradeCalculation</code></td> |
| |
| |
| <td class="type"> |
| |
| |
| <span class="param-type">object</span> |
| |
| |
| |
| </td> |
| |
| |
| <td class="attributes"> |
| |
| <optional><br> |
| |
| |
| |
| </td> |
| |
| |
| |
| |
| <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> |
| </tr> |
| |
| |
| </tbody> |
| </table> |
| |
| |
| |
| |
| <dl class="details"> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <dt class="tag-source">Source:</dt> |
| <dd class="tag-source"><ul class="dummy"><li> |
| <a href="core.js.html">core.js</a>, <a href="core.js.html#line1609">line 1609</a> |
| </li></ul></dd> |
| |
| |
| |
| |
| |
| |
| |
| </dl> |
| |
| |
| |
| |
| |
| |
| |
| |
| <h4 class="name" id="DashboardItem">DashboardItem</h4> |
| |
| |
| |
| |
| <div class="description"> |
| Defines dashboard items in DTPS |
| </div> |
| |
| |
| |
| <h5>Type:</h5> |
| <ul> |
| <li> |
| |
| <span class="param-type">Object</span> |
| |
| |
| </li> |
| </ul> |
| |
| |
| |
| |
| |
| <h5 class="subsection-title">Properties:</h5> |
| |
| |
| |
| <table class="props"> |
| <thead> |
| <tr> |
| |
| <th>Name</th> |
| |
| |
| <th>Type</th> |
| |
| |
| |
| |
| |
| <th class="last">Description</th> |
| </tr> |
| </thead> |
| |
| <tbody> |
| |
| |
| <tr> |
| |
| <td class="name"><code>name</code></td> |
| |
| |
| <td class="type"> |
| |
| |
| <span class="param-type">string</span> |
| |
| |
| |
| </td> |
| |
| |
| |
| |
| |
| <td class="description last">Dashbord item name</td> |
| </tr> |
| |
| |
| |
| <tr> |
| |
| <td class="name"><code>id</code></td> |
| |
| |
| <td class="type"> |
| |
| |
| <span class="param-type">string</span> |
| |
| |
| |
| </td> |
| |
| |
| |
| |
| |
| <td class="description last">Unique dashboard item ID</td> |
| </tr> |
| |
| |
| |
| <tr> |
| |
| <td class="name"><code>icon</code></td> |
| |
| |
| <td class="type"> |
| |
| |
| <span class="param-type">string</span> |
| |
| |
| |
| </td> |
| |
| |
| |
| |
| |
| <td class="description last">Dashboard item icon</td> |
| </tr> |
| |
| |
| |
| <tr> |
| |
| <td class="name"><code>supportsCompactMode</code></td> |
| |
| |
| <td class="type"> |
| |
| |
| <span class="param-type">boolean</span> |
| |
| |
| |
| </td> |
| |
| |
| |
| |
| |
| <td class="description last">True if this dashboard item supports compact mode</td> |
| </tr> |
| |
| |
| |
| <tr> |
| |
| <td class="name"><code>size</code></td> |
| |
| |
| <td class="type"> |
| |
| |
| <span class="param-type">number</span> |
| |
| |
| |
| </td> |
| |
| |
| |
| |
| |
| <td class="description last">The approximate size of this dashboard item relative to other dashboard items. Should be no less than 20.</td> |
| </tr> |
| |
| |
| |
| <tr> |
| |
| <td class="name"><code>defaultSide</code></td> |
| |
| |
| <td class="type"> |
| |
| |
| <span class="param-type">string</span> |
| |
| |
| |
| </td> |
| |
| |
| |
| |
| |
| <td class="description last">The default side of this dashboard item. Either "right" or "left".</td> |
| </tr> |
| |
| |
| |
| <tr> |
| |
| <td class="name"><code>compact</code></td> |
| |
| |
| <td class="type"> |
| |
| |
| <span class="param-type">boolean</span> |
| |
| |
| |
| </td> |
| |
| |
| |
| |
| |
| <td class="description last">True if the user has turned on compact mode for this item.</td> |
| </tr> |
| |
| |
| </tbody> |
| </table> |
| |
| |
| |
| |
| <dl class="details"> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <dt class="tag-source">Source:</dt> |
| <dd class="tag-source"><ul class="dummy"><li> |
| <a href="assignments.js.html">assignments.js</a>, <a href="assignments.js.html#line1052">line 1052</a> |
| </li></ul></dd> |
| |
| |
| |
| |
| |
| |
| |
| </dl> |
| |
| |
| |
| |
| |
| |
| |
| |
| <h4 class="name" id="Date">Date</h4> |
| |
| |
| |
| |
| <div class="description"> |
| A date string recognized by <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/parse">Date.parse</a> |
| </div> |
| |
| |
| |
| <h5>Type:</h5> |
| <ul> |
| <li> |
| |
| <span class="param-type">string</span> |
| |
| |
| </li> |
| </ul> |
| |
| |
| |
| |
| |
| <dl class="details"> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <dt class="tag-source">Source:</dt> |
| <dd class="tag-source"><ul class="dummy"><li> |
| <a href="core.js.html">core.js</a>, <a href="core.js.html#line1593">line 1593</a> |
| </li></ul></dd> |
| |
| |
| |
| |
| |
| |
| |
| </dl> |
| |
| |
| |
| |
| |
| |
| |
| |
| <h4 class="name" id="DiscussionPost">DiscussionPost</h4> |
| |
| |
| |
| |
| <div class="description"> |
| Defines discussion post objects in DTPS |
| </div> |
| |
| |
| |
| <h5>Type:</h5> |
| <ul> |
| <li> |
| |
| <span class="param-type">Object</span> |
| |
| |
| </li> |
| </ul> |
| |
| |
| |
| |
| |
| <h5 class="subsection-title">Properties:</h5> |
| |
| |
| |
| <table class="props"> |
| <thead> |
| <tr> |
| |
| <th>Name</th> |
| |
| |
| <th>Type</th> |
| |
| |
| <th>Attributes</th> |
| |
| |
| |
| |
| <th class="last">Description</th> |
| </tr> |
| </thead> |
| |
| <tbody> |
| |
| |
| <tr> |
| |
| <td class="name"><code>id</code></td> |
| |
| |
| <td class="type"> |
| |
| |
| <span class="param-type">string</span> |
| |
| |
| |
| </td> |
| |
| |
| <td class="attributes"> |
| |
| |
| |
| </td> |
| |
| |
| |
| |
| <td class="description last">Discussion post ID</td> |
| </tr> |
| |
| |
| |
| <tr> |
| |
| <td class="name"><code>body</code></td> |
| |
| |
| <td class="type"> |
| |
| |
| <span class="param-type">string</span> |
| |
| |
| |
| </td> |
| |
| |
| <td class="attributes"> |
| |
| |
| |
| </td> |
| |
| |
| |
| |
| <td class="description last">Discussion post body HTML</td> |
| </tr> |
| |
| |
| |
| <tr> |
| |
| <td class="name"><code>postedAt</code></td> |
| |
| |
| <td class="type"> |
| |
| |
| <span class="param-type"><a href="global.html#Date">Date</a></span> |
| |
| |
| |
| </td> |
| |
| |
| <td class="attributes"> |
| |
| |
| |
| </td> |
| |
| |
| |
| |
| <td class="description last">Date for when the post was posted</td> |
| </tr> |
| |
| |
| |
| <tr> |
| |
| <td class="name"><code>depth</code></td> |
| |
| |
| <td class="type"> |
| |
| |
| <span class="param-type">number</span> |
| |
| |
| |
| </td> |
| |
| |
| <td class="attributes"> |
| |
| <optional><br> |
| |
| |
| |
| </td> |
| |
| |
| |
| |
| <td class="description last">The depth level this post is</td> |
| </tr> |
| |
| |
| |
| <tr> |
| |
| <td class="name"><code>author</code></td> |
| |
| |
| <td class="type"> |
| |
| |
| <span class="param-type"><a href="global.html#User">User</a></span> |
| |
| |
| |
| </td> |
| |
| |
| <td class="attributes"> |
| |
| <optional><br> |
| |
| |
| |
| </td> |
| |
| |
| |
| |
| <td class="description last">Discussion post author</td> |
| </tr> |
| |
| |
| |
| <tr> |
| |
| <td class="name"><code>replies</code></td> |
| |
| |
| <td class="type"> |
| |
| |
| <span class="param-type">Array.<<a href="global.html#DiscussionPost">DiscussionPost</a>></span> |
| |
| |
| |
| </td> |
| |
| |
| <td class="attributes"> |
| |
| <optional><br> |
| |
| |
| |
| </td> |
| |
| |
| |
| |
| <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> |
| </tr> |
| |
| |
| |
| <tr> |
| |
| <td class="name"><code>replyURL</code></td> |
| |
| |
| <td class="type"> |
| |
| |
| <span class="param-type">string</span> |
| |
| |
| |
| </td> |
| |
| |
| <td class="attributes"> |
| |
| <optional><br> |
| |
| |
| |
| </td> |
| |
| |
| |
| |
| <td class="description last">A URL that the user can visit to reply to this post</td> |
| </tr> |
| |
| |
| </tbody> |
| </table> |
| |
| |
| |
| |
| <dl class="details"> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <dt class="tag-source">Source:</dt> |
| <dd class="tag-source"><ul class="dummy"><li> |
| <a href="pages-discussions.js.html">pages-discussions.js</a>, <a href="pages-discussions.js.html#line480">line 480</a> |
| </li></ul></dd> |
| |
| |
| |
| |
| |
| |
| |
| </dl> |
| |
| |
| |
| |
| |
| |
| |
| |
| <h4 class="name" id="DiscussionThread">DiscussionThread</h4> |
| |
| |
| |
| |
| <div class="description"> |
| Defines discussion thread objects in DTPS |
| </div> |
| |
| |
| |
| <h5>Type:</h5> |
| <ul> |
| <li> |
| |
| <span class="param-type">Object</span> |
| |
| |
| </li> |
| </ul> |
| |
| |
| |
| |
| |
| <h5 class="subsection-title">Properties:</h5> |
| |
| |
| |
| <table class="props"> |
| <thead> |
| <tr> |
| |
| <th>Name</th> |
| |
| |
| <th>Type</th> |
| |
| |
| <th>Attributes</th> |
| |
| |
| |
| |
| <th class="last">Description</th> |
| </tr> |
| </thead> |
| |
| <tbody> |
| |
| |
| <tr> |
| |
| <td class="name"><code>title</code></td> |
| |
| |
| <td class="type"> |
| |
| |
| <span class="param-type">string</span> |
| |
| |
| |
| </td> |
| |
| |
| <td class="attributes"> |
| |
| |
| |
| </td> |
| |
| |
| |
| |
| <td class="description last">Title of the discussion thread</td> |
| </tr> |
| |
| |
| |
| <tr> |
| |
| <td class="name"><code>id</code></td> |
| |
| |
| <td class="type"> |
| |
| |
| <span class="param-type">string</span> |
| |
| |
| |
| </td> |
| |
| |
| <td class="attributes"> |
| |
| |
| |
| </td> |
| |
| |
| |
| |
| <td class="description last">Discussion thread ID</td> |
| </tr> |
| |
| |
| |
| <tr> |
| |
| <td class="name"><code>posts</code></td> |
| |
| |
| <td class="type"> |
| |
| |
| <span class="param-type">Array.<<a href="global.html#DiscussionPost">DiscussionPost</a>></span> |
| |
| |
| |
| </td> |
| |
| |
| <td class="attributes"> |
| |
| |
| |
| </td> |
| |
| |
| |
| |
| <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> |
| </tr> |
| |
| |
| |
| <tr> |
| |
| <td class="name"><code>locked</code></td> |
| |
| |
| <td class="type"> |
| |
| |
| <span class="param-type">boolean</span> |
| |
| |
| |
| </td> |
| |
| |
| <td class="attributes"> |
| |
| <optional><br> |
| |
| |
| |
| </td> |
| |
| |
| |
| |
| <td class="description last">True if posting to the discussion thread is locked</td> |
| </tr> |
| |
| |
| |
| <tr> |
| |
| <td class="name"><code>requireInitialPost</code></td> |
| |
| |
| <td class="type"> |
| |
| |
| <span class="param-type">boolean</span> |
| |
| |
| |
| </td> |
| |
| |
| <td class="attributes"> |
| |
| <optional><br> |
| |
| |
| |
| </td> |
| |
| |
| |
| |
| <td class="description last">True if the user must post before viewing others' posts</td> |
| </tr> |
| |
| |
| </tbody> |
| </table> |
| |
| |
| |
| |
| <dl class="details"> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <dt class="tag-source">Source:</dt> |
| <dd class="tag-source"><ul class="dummy"><li> |
| <a href="pages-discussions.js.html">pages-discussions.js</a>, <a href="pages-discussions.js.html#line470">line 470</a> |
| </li></ul></dd> |
| |
| |
| |
| |
| |
| |
| |
| </dl> |
| |
| |
| |
| |
| |
| |
| |
| |
| <h4 class="name" id="Module">Module</h4> |
| |
| |
| |
| |
| <div class="description"> |
| Defines module objects in DTPS |
| </div> |
| |
| |
| |
| <h5>Type:</h5> |
| <ul> |
| <li> |
| |
| <span class="param-type">Object</span> |
| |
| |
| </li> |
| </ul> |
| |
| |
| |
| |
| |
| <h5 class="subsection-title">Properties:</h5> |
| |
| |
| |
| <table class="props"> |
| <thead> |
| <tr> |
| |
| <th>Name</th> |
| |
| |
| <th>Type</th> |
| |
| |
| <th>Attributes</th> |
| |
| |
| |
| |
| <th class="last">Description</th> |
| </tr> |
| </thead> |
| |
| <tbody> |
| |
| |
| <tr> |
| |
| <td class="name"><code>title</code></td> |
| |
| |
| <td class="type"> |
| |
| |
| <span class="param-type">string</span> |
| |
| |
| |
| </td> |
| |
| |
| <td class="attributes"> |
| |
| |
| |
| </td> |
| |
| |
| |
| |
| <td class="description last">Title of the module</td> |
| </tr> |
| |
| |
| |
| <tr> |
| |
| <td class="name"><code>id</code></td> |
| |
| |
| <td class="type"> |
| |
| |
| <span class="param-type">string</span> |
| |
| |
| |
| </td> |
| |
| |
| <td class="attributes"> |
| |
| |
| |
| </td> |
| |
| |
| |
| |
| <td class="description last">Module ID</td> |
| </tr> |
| |
| |
| |
| <tr> |
| |
| <td class="name"><code>collapsed</code></td> |
| |
| |
| <td class="type"> |
| |
| |
| <span class="param-type">boolean</span> |
| |
| |
| |
| </td> |
| |
| |
| <td class="attributes"> |
| |
| <optional><br> |
| |
| |
| |
| </td> |
| |
| |
| |
| |
| <td class="description last">True if the module is collapsed, false otherwise. undefined or null if this module does not support collapsing.</td> |
| </tr> |
| |
| |
| |
| <tr> |
| |
| <td class="name"><code>items</code></td> |
| |
| |
| <td class="type"> |
| |
| |
| <span class="param-type">Array.<<a href="global.html#ModuleItem">ModuleItem</a>></span> |
| |
| |
| |
| </td> |
| |
| |
| <td class="attributes"> |
| |
| |
| |
| </td> |
| |
| |
| |
| |
| <td class="description last">An array of items for this module.</td> |
| </tr> |
| |
| |
| </tbody> |
| </table> |
| |
| |
| |
| |
| <dl class="details"> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <dt class="tag-source">Source:</dt> |
| <dd class="tag-source"><ul class="dummy"><li> |
| <a href="assignments.js.html">assignments.js</a>, <a href="assignments.js.html#line1005">line 1005</a> |
| </li></ul></dd> |
| |
| |
| |
| |
| |
| |
| |
| </dl> |
| |
| |
| |
| |
| |
| |
| |
| |
| <h4 class="name" id="ModuleItem">ModuleItem</h4> |
| |
| |
| |
| |
| <div class="description"> |
| Defines module items in DTPS |
| </div> |
| |
| |
| |
| <h5>Type:</h5> |
| <ul> |
| <li> |
| |
| <span class="param-type">Object</span> |
| |
| |
| </li> |
| </ul> |
| |
| |
| |
| |
| |
| <h5 class="subsection-title">Properties:</h5> |
| |
| |
| |
| <table class="props"> |
| <thead> |
| <tr> |
| |
| <th>Name</th> |
| |
| |
| <th>Type</th> |
| |
| |
| <th>Attributes</th> |
| |
| |
| |
| |
| <th class="last">Description</th> |
| </tr> |
| </thead> |
| |
| <tbody> |
| |
| |
| <tr> |
| |
| <td class="name"><code>type</code></td> |
| |
| |
| <td class="type"> |
| |
| |
| <span class="param-type">string</span> |
| |
| |
| |
| </td> |
| |
| |
| <td class="attributes"> |
| |
| |
| |
| </td> |
| |
| |
| |
| |
| <td class="description last">Either "assignment", "page", "discussion", "url", "embed", or "header".</td> |
| </tr> |
| |
| |
| |
| <tr> |
| |
| <td class="name"><code>title</code></td> |
| |
| |
| <td class="type"> |
| |
| |
| <span class="param-type">string</span> |
| |
| |
| |
| </td> |
| |
| |
| <td class="attributes"> |
| |
| <optional><br> |
| |
| |
| |
| </td> |
| |
| |
| |
| |
| <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> |
| </tr> |
| |
| |
| |
| <tr> |
| |
| <td class="name"><code>id</code></td> |
| |
| |
| <td class="type"> |
| |
| |
| <span class="param-type">string</span> |
| |
| |
| |
| </td> |
| |
| |
| <td class="attributes"> |
| |
| <optional><br> |
| |
| |
| |
| </td> |
| |
| |
| |
| |
| <td class="description last">Required for assignment, page, and discussion items.</td> |
| </tr> |
| |
| |
| |
| <tr> |
| |
| <td class="name"><code>url</code></td> |
| |
| |
| <td class="type"> |
| |
| |
| <span class="param-type">string</span> |
| |
| |
| |
| </td> |
| |
| |
| <td class="attributes"> |
| |
| <optional><br> |
| |
| |
| |
| </td> |
| |
| |
| |
| |
| <td class="description last">Required for URL and embed items.</td> |
| </tr> |
| |
| |
| |
| <tr> |
| |
| <td class="name"><code>indent</code></td> |
| |
| |
| <td class="type"> |
| |
| |
| <span class="param-type">number</span> |
| |
| |
| |
| </td> |
| |
| |
| <td class="attributes"> |
| |
| <optional><br> |
| |
| |
| |
| </td> |
| |
| |
| |
| |
| <td class="description last">Indent level</td> |
| </tr> |
| |
| |
| </tbody> |
| </table> |
| |
| |
| |
| |
| <dl class="details"> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <dt class="tag-source">Source:</dt> |
| <dd class="tag-source"><ul class="dummy"><li> |
| <a href="assignments.js.html">assignments.js</a>, <a href="assignments.js.html#line1014">line 1014</a> |
| </li></ul></dd> |
| |
| |
| |
| |
| |
| |
| |
| </dl> |
| |
| |
| |
| |
| |
| |
| |
| |
| <h4 class="name" id="Page">Page</h4> |
| |
| |
| |
| |
| <div class="description"> |
| Defines Page objects in DTPS |
| </div> |
| |
| |
| |
| <h5>Type:</h5> |
| <ul> |
| <li> |
| |
| <span class="param-type">Object</span> |
| |
| |
| </li> |
| </ul> |
| |
| |
| |
| |
| |
| <h5 class="subsection-title">Properties:</h5> |
| |
| |
| |
| <table class="props"> |
| <thead> |
| <tr> |
| |
| <th>Name</th> |
| |
| |
| <th>Type</th> |
| |
| |
| <th>Attributes</th> |
| |
| |
| |
| |
| <th class="last">Description</th> |
| </tr> |
| </thead> |
| |
| <tbody> |
| |
| |
| <tr> |
| |
| <td class="name"><code>title</code></td> |
| |
| |
| <td class="type"> |
| |
| |
| <span class="param-type">string</span> |
| |
| |
| |
| </td> |
| |
| |
| <td class="attributes"> |
| |
| |
| |
| </td> |
| |
| |
| |
| |
| <td class="description last">Page title</td> |
| </tr> |
| |
| |
| |
| <tr> |
| |
| <td class="name"><code>id</code></td> |
| |
| |
| <td class="type"> |
| |
| |
| <span class="param-type">string</span> |
| |
| |
| |
| </td> |
| |
| |
| <td class="attributes"> |
| |
| |
| |
| </td> |
| |
| |
| |
| |
| <td class="description last">Page ID</td> |
| </tr> |
| |
| |
| |
| <tr> |
| |
| <td class="name"><code>content</code></td> |
| |
| |
| <td class="type"> |
| |
| |
| <span class="param-type">string</span> |
| |
| |
| |
| </td> |
| |
| |
| <td class="attributes"> |
| |
| |
| |
| </td> |
| |
| |
| |
| |
| <td class="description last">Page content. Assume the page hasn't been selected/loaded if this is undefined.</td> |
| </tr> |
| |
| |
| |
| <tr> |
| |
| <td class="name"><code>updatedAt</code></td> |
| |
| |
| <td class="type"> |
| |
| |
| <span class="param-type"><a href="global.html#Date">Date</a></span> |
| |
| |
| |
| </td> |
| |
| |
| <td class="attributes"> |
| |
| <optional><br> |
| |
| |
| |
| </td> |
| |
| |
| |
| |
| <td class="description last">When the page was last updated</td> |
| </tr> |
| |
| |
| |
| <tr> |
| |
| <td class="name"><code>author</code></td> |
| |
| |
| <td class="type"> |
| |
| |
| <span class="param-type"><a href="global.html#User">User</a></span> |
| |
| |
| |
| </td> |
| |
| |
| <td class="attributes"> |
| |
| <optional><br> |
| |
| |
| |
| </td> |
| |
| |
| |
| |
| <td class="description last">Page author</td> |
| </tr> |
| |
| |
| </tbody> |
| </table> |
| |
| |
| |
| |
| <dl class="details"> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <dt class="tag-source">Source:</dt> |
| <dd class="tag-source"><ul class="dummy"><li> |
| <a href="pages-discussions.js.html">pages-discussions.js</a>, <a href="pages-discussions.js.html#line492">line 492</a> |
| </li></ul></dd> |
| |
| |
| |
| |
| |
| |
| |
| </dl> |
| |
| |
| |
| |
| |
| |
| |
| |
| <h4 class="name" id="RubricItem">RubricItem</h4> |
| |
| |
| |
| |
| <div class="description"> |
| Defines rubric item objects in DTPS |
| </div> |
| |
| |
| |
| <h5>Type:</h5> |
| <ul> |
| <li> |
| |
| <span class="param-type">Object</span> |
| |
| |
| </li> |
| </ul> |
| |
| |
| |
| |
| |
| <h5 class="subsection-title">Properties:</h5> |
| |
| |
| |
| <table class="props"> |
| <thead> |
| <tr> |
| |
| <th>Name</th> |
| |
| |
| <th>Type</th> |
| |
| |
| <th>Attributes</th> |
| |
| |
| |
| |
| <th class="last">Description</th> |
| </tr> |
| </thead> |
| |
| <tbody> |
| |
| |
| <tr> |
| |
| <td class="name"><code>title</code></td> |
| |
| |
| <td class="type"> |
| |
| |
| <span class="param-type">string</span> |
| |
| |
| |
| </td> |
| |
| |
| <td class="attributes"> |
| |
| |
| |
| </td> |
| |
| |
| |
| |
| <td class="description last">Title of the rubric item</td> |
| </tr> |
| |
| |
| |
| <tr> |
| |
| <td class="name"><code>id</code></td> |
| |
| |
| <td class="type"> |
| |
| |
| <span class="param-type">string</span> |
| |
| |
| |
| </td> |
| |
| |
| <td class="attributes"> |
| |
| |
| |
| </td> |
| |
| |
| |
| |
| <td class="description last">Rubric item ID (does NOT have to be unique)</td> |
| </tr> |
| |
| |
| |
| <tr> |
| |
| <td class="name"><code>value</code></td> |
| |
| |
| <td class="type"> |
| |
| |
| <span class="param-type">number</span> |
| |
| |
| |
| </td> |
| |
| |
| <td class="attributes"> |
| |
| |
| |
| </td> |
| |
| |
| |
| |
| <td class="description last">Total amount of points possible</td> |
| </tr> |
| |
| |
| |
| <tr> |
| |
| <td class="name"><code>outcome</code></td> |
| |
| |
| <td class="type"> |
| |
| |
| <span class="param-type">string</span> |
| |
| |
| |
| </td> |
| |
| |
| <td class="attributes"> |
| |
| <optional><br> |
| |
| |
| |
| </td> |
| |
| |
| |
| |
| <td class="description last">The ID of the outcome this rubric item is assessing. This is only used for grade calculation.</td> |
| </tr> |
| |
| |
| |
| <tr> |
| |
| <td class="name"><code>description</code></td> |
| |
| |
| <td class="type"> |
| |
| |
| <span class="param-type">string</span> |
| |
| |
| |
| </td> |
| |
| |
| <td class="attributes"> |
| |
| <optional><br> |
| |
| |
| |
| </td> |
| |
| |
| |
| |
| <td class="description last">Rubric item description</td> |
| </tr> |
| |
| |
| |
| <tr> |
| |
| <td class="name"><code>score</code></td> |
| |
| |
| <td class="type"> |
| |
| |
| <span class="param-type">number</span> |
| |
| |
| |
| </td> |
| |
| |
| <td class="attributes"> |
| |
| <optional><br> |
| |
| |
| |
| </td> |
| |
| |
| |
| |
| <td class="description last">Rubric assessment score in points</td> |
| </tr> |
| |
| |
| |
| <tr> |
| |
| <td class="name"><code>scoreName</code></td> |
| |
| |
| <td class="type"> |
| |
| |
| <span class="param-type">string</span> |
| |
| |
| |
| </td> |
| |
| |
| <td class="attributes"> |
| |
| <optional><br> |
| |
| |
| |
| </td> |
| |
| |
| |
| |
| <td class="description last">Rubric assessment score name</td> |
| </tr> |
| |
| |
| |
| <tr> |
| |
| <td class="name"><code>scoreColor</code></td> |
| |
| |
| <td class="type"> |
| |
| |
| <span class="param-type">string</span> |
| |
| |
| |
| </td> |
| |
| |
| <td class="attributes"> |
| |
| <optional><br> |
| |
| |
| |
| </td> |
| |
| |
| |
| |
| <td class="description last">Score color in CSS color format</td> |
| </tr> |
| |
| |
| </tbody> |
| </table> |
| |
| |
| |
| |
| <dl class="details"> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <dt class="tag-source">Source:</dt> |
| <dd class="tag-source"><ul class="dummy"><li> |
| <a href="assignments.js.html">assignments.js</a>, <a href="assignments.js.html#line1039">line 1039</a> |
| </li></ul></dd> |
| |
| |
| |
| |
| |
| |
| |
| </dl> |
| |
| |
| |
| |
| |
| |
| |
| |
| <h4 class="name" id="User">User</h4> |
| |
| |
| |
| |
| <div class="description"> |
| Defines user objects in DTPS |
| </div> |
| |
| |
| |
| <h5>Type:</h5> |
| <ul> |
| <li> |
| |
| <span class="param-type">Object</span> |
| |
| |
| </li> |
| </ul> |
| |
| |
| |
| |
| |
| <h5 class="subsection-title">Properties:</h5> |
| |
| |
| |
| <table class="props"> |
| <thead> |
| <tr> |
| |
| <th>Name</th> |
| |
| |
| <th>Type</th> |
| |
| |
| <th>Attributes</th> |
| |
| |
| |
| |
| <th class="last">Description</th> |
| </tr> |
| </thead> |
| |
| <tbody> |
| |
| |
| <tr> |
| |
| <td class="name"><code>name</code></td> |
| |
| |
| <td class="type"> |
| |
| |
| <span class="param-type">string</span> |
| |
| |
| |
| </td> |
| |
| |
| <td class="attributes"> |
| |
| |
| |
| </td> |
| |
| |
| |
| |
| <td class="description last">User name</td> |
| </tr> |
| |
| |
| |
| <tr> |
| |
| <td class="name"><code>id</code></td> |
| |
| |
| <td class="type"> |
| |
| |
| <span class="param-type">string</span> |
| |
| |
| |
| </td> |
| |
| |
| <td class="attributes"> |
| |
| |
| |
| </td> |
| |
| |
| |
| |
| <td class="description last">User ID</td> |
| </tr> |
| |
| |
| |
| <tr> |
| |
| <td class="name"><code>photoURL</code></td> |
| |
| |
| <td class="type"> |
| |
| |
| <span class="param-type">string</span> |
| |
| |
| |
| </td> |
| |
| |
| <td class="attributes"> |
| |
| |
| |
| </td> |
| |
| |
| |
| |
| <td class="description last">User photo URL</td> |
| </tr> |
| |
| |
| |
| <tr> |
| |
| <td class="name"><code>children</code></td> |
| |
| |
| <td class="type"> |
| |
| |
| <span class="param-type">Array.<<a href="global.html#User">User</a>></span> |
| |
| |
| |
| </td> |
| |
| |
| <td class="attributes"> |
| |
| <optional><br> |
| |
| |
| |
| </td> |
| |
| |
| |
| |
| <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> |
| </tr> |
| |
| |
| |
| <tr> |
| |
| <td class="name"><code>parent</code></td> |
| |
| |
| <td class="type"> |
| |
| |
| <span class="param-type">boolean</span> |
| |
| |
| |
| </td> |
| |
| |
| <td class="attributes"> |
| |
| |
| |
| </td> |
| |
| |
| |
| |
| <td class="description last">[ONLY FOR DTPS.USER] Automatically managed by DTPS. True if the user is a parent account.</td> |
| </tr> |
| |
| |
| |
| <tr> |
| |
| <td class="name"><code>lmsID</code></td> |
| |
| |
| <td class="type"> |
| |
| |
| <span class="param-type">string</span> |
| |
| |
| |
| </td> |
| |
| |
| <td class="attributes"> |
| |
| |
| |
| </td> |
| |
| |
| |
| |
| <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> |
| </tr> |
| |
| |
| </tbody> |
| </table> |
| |
| |
| |
| |
| <dl class="details"> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <dt class="tag-source">Source:</dt> |
| <dd class="tag-source"><ul class="dummy"><li> |
| <a href="core.js.html">core.js</a>, <a href="core.js.html#line1598">line 1598</a> |
| </li></ul></dd> |
| |
| |
| |
| |
| |
| |
| |
| </dl> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </article> |
| |
| </section> |
| |
| |
| |
| |
| </div> |
| |
| <nav> |
| <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> |
| </nav> |
| |
| <br class="clear"> |
| |
| <footer> |
| 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) |
| </footer> |
| |
| <script> prettyPrint(); </script> |
| <script src="scripts/linenumber.js"> </script> |
| </body> |
| </html> |