james/classcharts-api-js
1
0
Fork 0
mirror of https://github.com/classchartsapi/classcharts-api-js.git synced 2026-05-14 03:56:59 +00:00
Code Activity
classcharts-api-js/docs/interfaces/types.Student.html
James Cook c28cebf990 docs: update docs
2021-12-12 15:02:17 +00:00

1 line
No EOL
34 KiB
HTML
Raw Blame History

<!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>Student | classcharts-api</title><meta name="description" content="Documentation for classcharts-api"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script async src="../assets/search.js" id="search-script"></script></head><body><script>document.body.classList.add(localStorage.getItem("tsd-theme") || "os")</script><header><div class="tsd-page-toolbar"><div class="container"><div class="table-wrap"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget search no-caption">Search</label><input type="text" id="tsd-search-field"/></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">classcharts-api</a></div><div class="table-cell" id="tsd-widgets"><div id="tsd-filter"><a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a><div class="tsd-filter-group"><div class="tsd-select" id="tsd-filter-visibility"><span class="tsd-select-label">All</span><ul class="tsd-select-list"><li data-value="public">Public</li><li data-value="protected">Public/Protected</li><li data-value="private" class="selected">All</li></ul></div> <input type="checkbox" id="tsd-filter-inherited" checked/><label class="tsd-widget" for="tsd-filter-inherited">Inherited</label><input type="checkbox" id="tsd-filter-externals" checked/><label class="tsd-widget" for="tsd-filter-externals">Externals</label></div></div><a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a></div></div></div></div><div class="tsd-page-title"><div class="container"><ul class="tsd-breadcrumb"><li><a href="../modules.html">classcharts-api</a></li><li><a href="../modules/types.html">types</a></li><li><a href="types.Student.html">Student</a></li></ul><h1>Interface Student</h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><span class="target">Student</span></li></ul></section><section class="tsd-panel-group tsd-index-group"><h2>Index</h2><section class="tsd-panel tsd-index-panel"><div class="tsd-index-content"><section class="tsd-index-section "><h3>Properties</h3><ul class="tsd-index-list"><li class="tsd-kind-property tsd-parent-kind-interface"><a href="types.Student.html#allow_pupils_add_timetable_notes" class="tsd-kind-icon">allow_<wbr/>pupils_<wbr/>add_<wbr/>timetable_<wbr/>notes</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="types.Student.html#announcements_count" class="tsd-kind-icon">announcements_<wbr/>count</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="types.Student.html#avatar_url" class="tsd-kind-icon">avatar_<wbr/>url</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="types.Student.html#can_upload_attachments" class="tsd-kind-icon">can_<wbr/>upload_<wbr/>attachments</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="types.Student.html#detention_alias_plural_uc" class="tsd-kind-icon">detention_<wbr/>alias_<wbr/>plural_<wbr/>uc</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="types.Student.html#display_absences" class="tsd-kind-icon">display_<wbr/>absences</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="types.Student.html#display_activity" class="tsd-kind-icon">display_<wbr/>activity</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="types.Student.html#display_announcements" class="tsd-kind-icon">display_<wbr/>announcements</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="types.Student.html#display_attendance" class="tsd-kind-icon">display_<wbr/>attendance</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="types.Student.html#display_attendance_percentage" class="tsd-kind-icon">display_<wbr/>attendance_<wbr/>percentage</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="types.Student.html#display_attendance_type" class="tsd-kind-icon">display_<wbr/>attendance_<wbr/>type</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="types.Student.html#display_avatars" class="tsd-kind-icon">display_<wbr/>avatars</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="types.Student.html#display_behaviour" class="tsd-kind-icon">display_<wbr/>behaviour</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="types.Student.html#display_classes" class="tsd-kind-icon">display_<wbr/>classes</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="types.Student.html#display_concern_submission" class="tsd-kind-icon">display_<wbr/>concern_<wbr/>submission</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="types.Student.html#display_custom_fields" class="tsd-kind-icon">display_<wbr/>custom_<wbr/>fields</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="types.Student.html#display_detentions" class="tsd-kind-icon">display_<wbr/>detentions</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="types.Student.html#display_event_badges" class="tsd-kind-icon">display_<wbr/>event_<wbr/>badges</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="types.Student.html#display_homework" class="tsd-kind-icon">display_<wbr/>homework</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="types.Student.html#display_mental_health" class="tsd-kind-icon">display_<wbr/>mental_<wbr/>health</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="types.Student.html#display_parent_behaviour" class="tsd-kind-icon">display_<wbr/>parent_<wbr/>behaviour</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="types.Student.html#display_report_cards" class="tsd-kind-icon">display_<wbr/>report_<wbr/>cards</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="types.Student.html#display_rewards" class="tsd-kind-icon">display_<wbr/>rewards</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="types.Student.html#display_timetable" class="tsd-kind-icon">display_<wbr/>timetable</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="types.Student.html#display_two_way_communications" class="tsd-kind-icon">display_<wbr/>two_<wbr/>way_<wbr/>communications</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="types.Student.html#first_name" class="tsd-kind-icon">first_<wbr/>name</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="types.Student.html#has_birthday" class="tsd-kind-icon">has_<wbr/>birthday</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="types.Student.html#has_new_survey" class="tsd-kind-icon">has_<wbr/>new_<wbr/>survey</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="types.Student.html#id" class="tsd-kind-icon">id</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="types.Student.html#is_disabled" class="tsd-kind-icon">is_<wbr/>disabled</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="types.Student.html#last_name" class="tsd-kind-icon">last_<wbr/>name</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="types.Student.html#messages_count" class="tsd-kind-icon">messages_<wbr/>count</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="types.Student.html#name" class="tsd-kind-icon">name</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="types.Student.html#pupil_concerns_help_text" class="tsd-kind-icon">pupil_<wbr/>concerns_<wbr/>help_<wbr/>text</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="types.Student.html#pusher_channel_name" class="tsd-kind-icon">pusher_<wbr/>channel_<wbr/>name</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="types.Student.html#survey_id" class="tsd-kind-icon">survey_<wbr/>id</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Properties</h2><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="allow_pupils_add_timetable_notes" class="tsd-anchor"></a><h3>allow_<wbr/>pupils_<wbr/>add_<wbr/>timetable_<wbr/>notes</h3><div class="tsd-signature tsd-kind-icon">allow_<wbr/>pupils_<wbr/>add_<wbr/>timetable_<wbr/>notes<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/jamesatjaminit/classcharts-api/blob/b427ad1/src/types.ts#L30">types.ts:30</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="announcements_count" class="tsd-anchor"></a><h3>announcements_<wbr/>count</h3><div class="tsd-signature tsd-kind-icon">announcements_<wbr/>count<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/jamesatjaminit/classcharts-api/blob/b427ad1/src/types.ts#L31">types.ts:31</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="avatar_url" class="tsd-anchor"></a><h3>avatar_<wbr/>url</h3><div class="tsd-signature tsd-kind-icon">avatar_<wbr/>url<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/jamesatjaminit/classcharts-api/blob/b427ad1/src/types.ts#L6">types.ts:6</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="can_upload_attachments" class="tsd-anchor"></a><h3>can_<wbr/>upload_<wbr/>attachments</h3><div class="tsd-signature tsd-kind-icon">can_<wbr/>upload_<wbr/>attachments<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/jamesatjaminit/classcharts-api/blob/b427ad1/src/types.ts#L24">types.ts:24</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="detention_alias_plural_uc" class="tsd-anchor"></a><h3>detention_<wbr/>alias_<wbr/>plural_<wbr/>uc</h3><div class="tsd-signature tsd-kind-icon">detention_<wbr/>alias_<wbr/>plural_<wbr/>uc<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/jamesatjaminit/classcharts-api/blob/b427ad1/src/types.ts#L37">types.ts:37</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="display_absences" class="tsd-anchor"></a><h3>display_<wbr/>absences</h3><div class="tsd-signature tsd-kind-icon">display_<wbr/>absences<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/jamesatjaminit/classcharts-api/blob/b427ad1/src/types.ts#L23">types.ts:23</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="display_activity" class="tsd-anchor"></a><h3>display_<wbr/>activity</h3><div class="tsd-signature tsd-kind-icon">display_<wbr/>activity<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/jamesatjaminit/classcharts-api/blob/b427ad1/src/types.ts#L18">types.ts:18</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="display_announcements" class="tsd-anchor"></a><h3>display_<wbr/>announcements</h3><div class="tsd-signature tsd-kind-icon">display_<wbr/>announcements<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/jamesatjaminit/classcharts-api/blob/b427ad1/src/types.ts#L14">types.ts:14</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="display_attendance" class="tsd-anchor"></a><h3>display_<wbr/>attendance</h3><div class="tsd-signature tsd-kind-icon">display_<wbr/>attendance<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/jamesatjaminit/classcharts-api/blob/b427ad1/src/types.ts#L15">types.ts:15</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="display_attendance_percentage" class="tsd-anchor"></a><h3>display_<wbr/>attendance_<wbr/>percentage</h3><div class="tsd-signature tsd-kind-icon">display_<wbr/>attendance_<wbr/>percentage<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/jamesatjaminit/classcharts-api/blob/b427ad1/src/types.ts#L17">types.ts:17</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="display_attendance_type" class="tsd-anchor"></a><h3>display_<wbr/>attendance_<wbr/>type</h3><div class="tsd-signature tsd-kind-icon">display_<wbr/>attendance_<wbr/>type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/jamesatjaminit/classcharts-api/blob/b427ad1/src/types.ts#L16">types.ts:16</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="display_avatars" class="tsd-anchor"></a><h3>display_<wbr/>avatars</h3><div class="tsd-signature tsd-kind-icon">display_<wbr/>avatars<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/jamesatjaminit/classcharts-api/blob/b427ad1/src/types.ts#L26">types.ts:26</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="display_behaviour" class="tsd-anchor"></a><h3>display_<wbr/>behaviour</h3><div class="tsd-signature tsd-kind-icon">display_<wbr/>behaviour<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/jamesatjaminit/classcharts-api/blob/b427ad1/src/types.ts#L7">types.ts:7</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="display_classes" class="tsd-anchor"></a><h3>display_<wbr/>classes</h3><div class="tsd-signature tsd-kind-icon">display_<wbr/>classes<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/jamesatjaminit/classcharts-api/blob/b427ad1/src/types.ts#L13">types.ts:13</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="display_concern_submission" class="tsd-anchor"></a><h3>display_<wbr/>concern_<wbr/>submission</h3><div class="tsd-signature tsd-kind-icon">display_<wbr/>concern_<wbr/>submission<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/jamesatjaminit/classcharts-api/blob/b427ad1/src/types.ts#L27">types.ts:27</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="display_custom_fields" class="tsd-anchor"></a><h3>display_<wbr/>custom_<wbr/>fields</h3><div class="tsd-signature tsd-kind-icon">display_<wbr/>custom_<wbr/>fields<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/jamesatjaminit/classcharts-api/blob/b427ad1/src/types.ts#L28">types.ts:28</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="display_detentions" class="tsd-anchor"></a><h3>display_<wbr/>detentions</h3><div class="tsd-signature tsd-kind-icon">display_<wbr/>detentions<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/jamesatjaminit/classcharts-api/blob/b427ad1/src/types.ts#L11">types.ts:11</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="display_event_badges" class="tsd-anchor"></a><h3>display_<wbr/>event_<wbr/>badges</h3><div class="tsd-signature tsd-kind-icon">display_<wbr/>event_<wbr/>badges<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/jamesatjaminit/classcharts-api/blob/b427ad1/src/types.ts#L25">types.ts:25</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="display_homework" class="tsd-anchor"></a><h3>display_<wbr/>homework</h3><div class="tsd-signature tsd-kind-icon">display_<wbr/>homework<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/jamesatjaminit/classcharts-api/blob/b427ad1/src/types.ts#L9">types.ts:9</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="display_mental_health" class="tsd-anchor"></a><h3>display_<wbr/>mental_<wbr/>health</h3><div class="tsd-signature tsd-kind-icon">display_<wbr/>mental_<wbr/>health<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/jamesatjaminit/classcharts-api/blob/b427ad1/src/types.ts#L19">types.ts:19</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="display_parent_behaviour" class="tsd-anchor"></a><h3>display_<wbr/>parent_<wbr/>behaviour</h3><div class="tsd-signature tsd-kind-icon">display_<wbr/>parent_<wbr/>behaviour<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/jamesatjaminit/classcharts-api/blob/b427ad1/src/types.ts#L8">types.ts:8</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="display_report_cards" class="tsd-anchor"></a><h3>display_<wbr/>report_<wbr/>cards</h3><div class="tsd-signature tsd-kind-icon">display_<wbr/>report_<wbr/>cards<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/jamesatjaminit/classcharts-api/blob/b427ad1/src/types.ts#L12">types.ts:12</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="display_rewards" class="tsd-anchor"></a><h3>display_<wbr/>rewards</h3><div class="tsd-signature tsd-kind-icon">display_<wbr/>rewards<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/jamesatjaminit/classcharts-api/blob/b427ad1/src/types.ts#L10">types.ts:10</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="display_timetable" class="tsd-anchor"></a><h3>display_<wbr/>timetable</h3><div class="tsd-signature tsd-kind-icon">display_<wbr/>timetable<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/jamesatjaminit/classcharts-api/blob/b427ad1/src/types.ts#L20">types.ts:20</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="display_two_way_communications" class="tsd-anchor"></a><h3>display_<wbr/>two_<wbr/>way_<wbr/>communications</h3><div class="tsd-signature tsd-kind-icon">display_<wbr/>two_<wbr/>way_<wbr/>communications<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/jamesatjaminit/classcharts-api/blob/b427ad1/src/types.ts#L22">types.ts:22</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="first_name" class="tsd-anchor"></a><h3>first_<wbr/>name</h3><div class="tsd-signature tsd-kind-icon">first_<wbr/>name<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/jamesatjaminit/classcharts-api/blob/b427ad1/src/types.ts#L4">types.ts:4</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="has_birthday" class="tsd-anchor"></a><h3>has_<wbr/>birthday</h3><div class="tsd-signature tsd-kind-icon">has_<wbr/>birthday<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/jamesatjaminit/classcharts-api/blob/b427ad1/src/types.ts#L34">types.ts:34</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="has_new_survey" class="tsd-anchor"></a><h3>has_<wbr/>new_<wbr/>survey</h3><div class="tsd-signature tsd-kind-icon">has_<wbr/>new_<wbr/>survey<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/jamesatjaminit/classcharts-api/blob/b427ad1/src/types.ts#L35">types.ts:35</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="id" class="tsd-anchor"></a><h3>id</h3><div class="tsd-signature tsd-kind-icon">id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/jamesatjaminit/classcharts-api/blob/b427ad1/src/types.ts#L2">types.ts:2</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="is_disabled" class="tsd-anchor"></a><h3>is_<wbr/>disabled</h3><div class="tsd-signature tsd-kind-icon">is_<wbr/>disabled<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/jamesatjaminit/classcharts-api/blob/b427ad1/src/types.ts#L21">types.ts:21</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="last_name" class="tsd-anchor"></a><h3>last_<wbr/>name</h3><div class="tsd-signature tsd-kind-icon">last_<wbr/>name<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/jamesatjaminit/classcharts-api/blob/b427ad1/src/types.ts#L5">types.ts:5</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="messages_count" class="tsd-anchor"></a><h3>messages_<wbr/>count</h3><div class="tsd-signature tsd-kind-icon">messages_<wbr/>count<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/jamesatjaminit/classcharts-api/blob/b427ad1/src/types.ts#L32">types.ts:32</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="name" class="tsd-anchor"></a><h3>name</h3><div class="tsd-signature tsd-kind-icon">name<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/jamesatjaminit/classcharts-api/blob/b427ad1/src/types.ts#L3">types.ts:3</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="pupil_concerns_help_text" class="tsd-anchor"></a><h3>pupil_<wbr/>concerns_<wbr/>help_<wbr/>text</h3><div class="tsd-signature tsd-kind-icon">pupil_<wbr/>concerns_<wbr/>help_<wbr/>text<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/jamesatjaminit/classcharts-api/blob/b427ad1/src/types.ts#L29">types.ts:29</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="pusher_channel_name" class="tsd-anchor"></a><h3>pusher_<wbr/>channel_<wbr/>name</h3><div class="tsd-signature tsd-kind-icon">pusher_<wbr/>channel_<wbr/>name<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/jamesatjaminit/classcharts-api/blob/b427ad1/src/types.ts#L33">types.ts:33</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="survey_id" class="tsd-anchor"></a><h3>survey_<wbr/>id</h3><div class="tsd-signature tsd-kind-icon">survey_<wbr/>id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/jamesatjaminit/classcharts-api/blob/b427ad1/src/types.ts#L36">types.ts:36</a></li></ul></aside></section></section></div><div class="col-4 col-menu menu-sticky-wrap menu-highlight"><nav class="tsd-navigation primary"><ul><li class=""><a href="../modules.html">Modules</a></li><li class=" tsd-kind-module"><a href="../modules/client.html">client</a></li><li class=" tsd-kind-module"><a href="../modules/consts.html">consts</a></li><li class=" tsd-kind-module"><a href="../modules/index.html">index</a></li><li class="current tsd-kind-module"><a href="../modules/types.html">types</a></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="current tsd-kind-interface tsd-parent-kind-module"><a href="types.Student.html" class="tsd-kind-icon">Student</a><ul><li class="tsd-kind-property tsd-parent-kind-interface"><a href="types.Student.html#allow_pupils_add_timetable_notes" class="tsd-kind-icon">allow_<wbr/>pupils_<wbr/>add_<wbr/>timetable_<wbr/>notes</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="types.Student.html#announcements_count" class="tsd-kind-icon">announcements_<wbr/>count</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="types.Student.html#avatar_url" class="tsd-kind-icon">avatar_<wbr/>url</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="types.Student.html#can_upload_attachments" class="tsd-kind-icon">can_<wbr/>upload_<wbr/>attachments</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="types.Student.html#detention_alias_plural_uc" class="tsd-kind-icon">detention_<wbr/>alias_<wbr/>plural_<wbr/>uc</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="types.Student.html#display_absences" class="tsd-kind-icon">display_<wbr/>absences</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="types.Student.html#display_activity" class="tsd-kind-icon">display_<wbr/>activity</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="types.Student.html#display_announcements" class="tsd-kind-icon">display_<wbr/>announcements</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="types.Student.html#display_attendance" class="tsd-kind-icon">display_<wbr/>attendance</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="types.Student.html#display_attendance_percentage" class="tsd-kind-icon">display_<wbr/>attendance_<wbr/>percentage</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="types.Student.html#display_attendance_type" class="tsd-kind-icon">display_<wbr/>attendance_<wbr/>type</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="types.Student.html#display_avatars" class="tsd-kind-icon">display_<wbr/>avatars</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="types.Student.html#display_behaviour" class="tsd-kind-icon">display_<wbr/>behaviour</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="types.Student.html#display_classes" class="tsd-kind-icon">display_<wbr/>classes</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="types.Student.html#display_concern_submission" class="tsd-kind-icon">display_<wbr/>concern_<wbr/>submission</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="types.Student.html#display_custom_fields" class="tsd-kind-icon">display_<wbr/>custom_<wbr/>fields</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="types.Student.html#display_detentions" class="tsd-kind-icon">display_<wbr/>detentions</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="types.Student.html#display_event_badges" class="tsd-kind-icon">display_<wbr/>event_<wbr/>badges</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="types.Student.html#display_homework" class="tsd-kind-icon">display_<wbr/>homework</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="types.Student.html#display_mental_health" class="tsd-kind-icon">display_<wbr/>mental_<wbr/>health</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="types.Student.html#display_parent_behaviour" class="tsd-kind-icon">display_<wbr/>parent_<wbr/>behaviour</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="types.Student.html#display_report_cards" class="tsd-kind-icon">display_<wbr/>report_<wbr/>cards</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="types.Student.html#display_rewards" class="tsd-kind-icon">display_<wbr/>rewards</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="types.Student.html#display_timetable" class="tsd-kind-icon">display_<wbr/>timetable</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="types.Student.html#display_two_way_communications" class="tsd-kind-icon">display_<wbr/>two_<wbr/>way_<wbr/>communications</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="types.Student.html#first_name" class="tsd-kind-icon">first_<wbr/>name</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="types.Student.html#has_birthday" class="tsd-kind-icon">has_<wbr/>birthday</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="types.Student.html#has_new_survey" class="tsd-kind-icon">has_<wbr/>new_<wbr/>survey</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="types.Student.html#id" class="tsd-kind-icon">id</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="types.Student.html#is_disabled" class="tsd-kind-icon">is_<wbr/>disabled</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="types.Student.html#last_name" class="tsd-kind-icon">last_<wbr/>name</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="types.Student.html#messages_count" class="tsd-kind-icon">messages_<wbr/>count</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="types.Student.html#name" class="tsd-kind-icon">name</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="types.Student.html#pupil_concerns_help_text" class="tsd-kind-icon">pupil_<wbr/>concerns_<wbr/>help_<wbr/>text</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="types.Student.html#pusher_channel_name" class="tsd-kind-icon">pusher_<wbr/>channel_<wbr/>name</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="types.Student.html#survey_id" class="tsd-kind-icon">survey_<wbr/>id</a></li></ul></li></ul></nav></div></div></div><footer class="with-border-bottom"><div class="container"><h2>Legend</h2><div class="tsd-legend-group"><ul class="tsd-legend"><li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li><li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li><li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li></ul></div><h2>Settings</h2><p>Theme <select id="theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></p></div></footer><div class="container tsd-generator"><p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div><div class="overlay"></div><script src="../assets/main.js"></script></body></html>
View git blame Copy permalink