2021-12-12 15:02:17 +00:00
<!DOCTYPE html> < html class = "default" > < head > < meta charSet = "utf-8" / > < meta http-equiv = "x-ua-compatible" content = "IE=edge" / > < title > ClasschartsClient | 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/client.html" > client< / a > < / li > < li > < a href = "client.ClasschartsClient.html" > ClasschartsClient< / a > < / li > < / ul > < h1 > Class ClasschartsClient< / h1 > < / div > < / div > < / header > < div class = "container container-main" > < div class = "row" > < div class = "col-8 col-content" > < section class = "tsd-panel tsd-comment" > < div class = "tsd-comment tsd-typography" > < div class = "lead" >
2021-10-29 15:46:44 +01:00
< p > The base client< / p >
2022-01-31 23:20:27 +00:00
< / div > < / div > < / section > < section class = "tsd-panel tsd-hierarchy" > < h3 > Hierarchy< / h3 > < ul class = "tsd-hierarchy" > < li > < span class = "target" > ClasschartsClient< / 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 > Constructors< / h3 > < ul class = "tsd-index-list" > < li class = "tsd-kind-constructor tsd-parent-kind-class" > < a href = "client.ClasschartsClient.html#constructor" class = "tsd-kind-icon" > constructor< / a > < / li > < / ul > < / section > < section class = "tsd-index-section " > < h3 > Properties< / h3 > < ul class = "tsd-index-list" > < li class = "tsd-kind-property tsd-parent-kind-class tsd-is-private" > < a href = "client.ClasschartsClient.html#authCookies" class = "tsd-kind-icon" > auth< wbr / > Cookies< / a > < / li > < li class = "tsd-kind-property tsd-parent-kind-class" > < a href = "client.ClasschartsClient.html#dateOfBirth" class = "tsd-kind-icon" > date< wbr / > Of< wbr / > Birth< / a > < / li > < li class = "tsd-kind-property tsd-parent-kind-class tsd-is-private" > < a href = "client.ClasschartsClient.html#sessionId" class = "tsd-kind-icon" > session< wbr / > Id< / a > < / li > < li class = "tsd-kind-property tsd-parent-kind-class" > < a href = "client.ClasschartsClient.html#studentCode" class = "tsd-kind-icon" > student< wbr / > Code< / a > < / li > < li class = "tsd-kind-property tsd-parent-kind-class" > < a href = "client.ClasschartsClient.html#studentId" class = "tsd-kind-icon" > student< wbr / > Id< / a > < / li > < li class = "tsd-kind-property tsd-parent-kind-class" > < a href = "client.ClasschartsClient.html#studentName" class = "tsd-kind-icon" > student< wbr / > Name< / a > < / li > < / ul > < / section > < section class = "tsd-index-section " > < h3 > Methods< / h3 > < ul class = "tsd-index-list" > < li class = "tsd-kind-method tsd-parent-kind-class" > < a href = "client.ClasschartsClient.html#getActivity" class = "tsd-kind-icon" > get< wbr / > Activity< / a > < / li > < li class = "tsd-kind-method tsd-parent-kind-class" > < a href = "client.ClasschartsClient.html#getBadges" class = "tsd-kind-icon" > get< wbr / > Badges< / a > < / li > < li class = "tsd-kind-method tsd-parent-kind-class" > < a href = "client.ClasschartsClient.html#getBehaviour" class = "tsd-kind-icon" > get< wbr / > Behaviour< / a > < / li > < li class = "tsd-kind-method tsd-parent-kind-class" > < a href = "client.ClasschartsClient.html#getLessons" class = "tsd-kind-icon" > get< wbr / > Lessons< / a > < / li > < li class = "tsd-kind-method tsd-parent-kind-class" > < a href = "client.ClasschartsClient.html#getStudentInfo" class = "tsd-kind-icon" > get< wbr / > Student< wbr / > Info< / a > < / li > < li class = "tsd-kind-method tsd-parent-kind-class" > < a href = "client.ClasschartsClient.html#listHomeworks" class = "tsd-kind-icon" > list< wbr / > Homeworks< / a > < / li > < li class = "tsd-kind-method tsd-parent-kind-class" > < a href = "client.ClasschartsClient.html#login" class = "tsd-kind-icon" > login< / a > < / li > < li class = "tsd-kind-method tsd-parent-kind-class" > < a href = "client.ClasschartsClient.html#makeAuthedRequest" class = "tsd-kind-icon" > make< wbr / > Authed< wbr / > Request< / a > < / li > < / ul > < / section > < / div > < / section > < / section > < section class = "tsd-panel-group tsd-member-group " > < h2 > Constructors< / h2 > < section class = "tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class" > < a id = "constructor" class = "tsd-anchor" > < / a > < h3 class = "tsd-anchor-link" > constructor< a href = "#constructor" aria-label = "Permalink" class = "tsd-anchor-icon" > < svg xmlns = "http://www.w3.org/2000/svg" class = "icon icon-tabler icon-tabler-link" viewBox = "0 0 24 24" stroke-width = "2" stroke = "currentColor" fill = "none" stroke-linecap = "round" stroke-linejoin = "round" > < path stroke = "none" d = "M0 0h24v24H0z" fill = "none" > < / path > < path d = "M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5" > < / path > < path d = "M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5" > < / path > < / svg > < / a > < / h3 > < ul class = "tsd-signatures tsd-kind-constructor tsd-parent-kind-class" > < li class = "tsd-signature tsd-kind-icon" > new < wbr / > Classcharts< wbr / > Client< span class = "tsd-signature-symbol" > (< / span > studentCode< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > string< / span > , dateOfBirth< span class = "tsd-signature-symbol" > ?: < / span > < span class = "tsd-signature-type" > string< / span > < span class = "tsd-signature-symbol" > )< / span > < span c
2021-10-29 15:46:44 +01:00
< p > Classcharts student code< / p >
2021-11-23 22:23:23 +00:00
< / div > < / div > < / li > < li > < h5 > < span class = "tsd-flag ts-flagOptional" > Optional< / span > dateOfBirth: < span class = "tsd-signature-type" > string< / span > < / h5 > < div class = "tsd-comment tsd-typography" > < div class = "lead" >
2021-10-29 15:46:44 +01:00
< p > Student' s date of birth< / p >
2022-01-31 23:20:27 +00:00
< / div > < / div > < / li > < / ul > < h4 class = "tsd-returns-title" > Returns < a href = "client.ClasschartsClient.html" class = "tsd-signature-type" data-tsd-kind = "Class" > ClasschartsClient< / a > < / h4 > < / li > < / ul > < / 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-class tsd-is-private" > < a id = "authCookies" class = "tsd-anchor" > < / a > < h3 class = "tsd-anchor-link" > < span class = "tsd-flag ts-flagPrivate" > Private< / span > auth< wbr / > Cookies< a href = "#authCookies" aria-label = "Permalink" class = "tsd-anchor-icon" > < svg xmlns = "http://www.w3.org/2000/svg" class = "icon icon-tabler icon-tabler-link" viewBox = "0 0 24 24" stroke-width = "2" stroke = "currentColor" fill = "none" stroke-linecap = "round" stroke-linejoin = "round" > < path stroke = "none" d = "M0 0h24v24H0z" fill = "none" > < / path > < path d = "M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5" > < / path > < path d = "M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5" > < / path > < / svg > < / a > < / h3 > < div class = "tsd-signature tsd-kind-icon" > auth< wbr / > Cookies< span class = "tsd-signature-symbol" > :< / span > < span class = "tsd-signature-type" > undefined< / span > < span class = "tsd-signature-symbol" > | < / span > < span class = "tsd-signature-type" > string< / span > < span class = "tsd-signature-symbol" > []< / span > < / div > < aside class = "tsd-sources" > < ul > < li > Defined in < a href = "https://github.com/jamesatjaminit/classcharts-api/blob/48d03a0/src/client.ts#L25" > client.ts:25< / a > < / li > < / ul > < / aside > < / section > < section class = "tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class" > < a id = "dateOfBirth" class = "tsd-anchor" > < / a > < h3 class = "tsd-anchor-link" > date< wbr / > Of< wbr / > Birth< a href = "#dateOfBirth" aria-label = "Permalink" class = "tsd-anchor-icon" > < svg xmlns = "http://www.w3.org/2000/svg" class = "icon icon-tabler icon-tabler-link" viewBox = "0 0 24 24" stroke-width = "2" stroke = "currentColor" fill = "none" stroke-linecap = "round" stroke-linejoin = "round" > < path stroke = "none" d = "M0 0h24v24H0z" fill = "none" > < / path > < path d = "M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5" > < / path > < path d = "M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5" > < / path > < / svg > < / a > < / h3 > < div class = "tsd-signature tsd-kind-icon" > date< wbr / > Of< wbr / > Birth< span class = "tsd-signature-symbol" > :< / span > < span class = "tsd-signature-type" > string< / span > < span class = "tsd-signature-symbol" > = " " < / span > < / div > < aside class = "tsd-sources" > < ul > < li > Defined in < a href = "https://github.com/jamesatjaminit/classcharts-api/blob/48d03a0/src/client.ts#L22" > client.ts:22< / a > < / li > < / ul > < / aside > < / section > < section class = "tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private" > < a id = "sessionId" class = "tsd-anchor" > < / a > < h3 class = "tsd-anchor-link" > < span class = "tsd-flag ts-flagPrivate" > Private< / span > session< wbr / > Id< a href = "#sessionId" aria-label = "Permalink" class = "tsd-anchor-icon" > < svg xmlns = "http://www.w3.org/2000/svg" class = "icon icon-tabler icon-tabler-link" viewBox = "0 0 24 24" stroke-width = "2" stroke = "currentColor" fill = "none" stroke-linecap = "round" stroke-linejoin = "round" > < path stroke = "none" d = "M0 0h24v24H0z" fill = "none" > < / path > < path d = "M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5" > < / path > < path d = "M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5" > < / path > < / svg > < / a > < / h3 > < div class = "tsd-signature tsd-kind-icon" > session< wbr / > Id< span class = "tsd-signature-symbol" > :< / span > < span class = "tsd-signature-type" > string< / span > < span class = "tsd-signature-symbol" > = " " < / span > < / div > < aside class = "tsd-sources" > < ul > < li > Defined in < a href = "https://github.com/jamesatjaminit/classcharts-api/blob/48d03a0/src/client.ts#L26" > client.ts:26< / a > < / li > < / ul > < / aside > < / section > < section class = "tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class" > < a id = "studentCode" class = "tsd-anchor" > < / a > < h3 class = "tsd-anchor-link" > student< wbr / > Code< a href = "#studentCode" aria-label = "Permalink" class = "tsd-anchor-icon" > < svg xmlns = "http://www.w3.org/2000/svg" class = "icon icon-tabler icon-tabler-link" viewBox = "0 0 24 24" stroke-width = "2" stroke = "currentColor" fill = "none" stroke-linecap = "round" stroke-linejoin = "round" > < path stroke = "none" d =
2021-10-29 15:46:44 +01:00
< p > Get' s the logged in student' s general activity< / p >
2021-11-23 22:23:23 +00:00
< / div > < / div > < h4 class = "tsd-parameters-title" > Parameters< / h4 > < ul class = "tsd-parameters" > < li > < h5 > < span class = "tsd-flag ts-flagOptional" > Optional< / span > options: < a href = "../interfaces/types.GetActivityOptions.html" class = "tsd-signature-type" data-tsd-kind = "Interface" > GetActivityOptions< / a > < / h5 > < div class = "tsd-comment tsd-typography" > < div class = "lead" >
2021-10-29 15:46:44 +01:00
< p > GetActivityOptions< / p >
< / div > < / div > < / li > < / ul > < h4 class = "tsd-returns-title" > Returns < span class = "tsd-signature-type" > Promise< / span > < span class = "tsd-signature-symbol" > < < / span > < a href = "../interfaces/types.ActivityResponse.html" class = "tsd-signature-type" data-tsd-kind = "Interface" > ActivityResponse< / a > < span class = "tsd-signature-symbol" > > < / span > < / h4 > < div > < p > Activity data< / p >
2022-01-31 23:20:27 +00:00
< / div > < / li > < / ul > < / section > < section class = "tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class" > < a id = "getBadges" class = "tsd-anchor" > < / a > < h3 class = "tsd-anchor-link" > get< wbr / > Badges< a href = "#getBadges" aria-label = "Permalink" class = "tsd-anchor-icon" > < svg xmlns = "http://www.w3.org/2000/svg" class = "icon icon-tabler icon-tabler-link" viewBox = "0 0 24 24" stroke-width = "2" stroke = "currentColor" fill = "none" stroke-linecap = "round" stroke-linejoin = "round" > < path stroke = "none" d = "M0 0h24v24H0z" fill = "none" > < / path > < path d = "M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5" > < / path > < path d = "M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5" > < / path > < / svg > < / a > < / h3 > < ul class = "tsd-signatures tsd-kind-method tsd-parent-kind-class" > < li class = "tsd-signature tsd-kind-icon" > get< wbr / > Badges< span class = "tsd-signature-symbol" > (< / span > < span class = "tsd-signature-symbol" > )< / span > < span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > Promise< / span > < span class = "tsd-signature-symbol" > < < / span > < a href = "../modules/types.html#BadgesResponse" class = "tsd-signature-type" data-tsd-kind = "Type alias" > BadgesResponse< / a > < span class = "tsd-signature-symbol" > > < / span > < / li > < / ul > < ul class = "tsd-descriptions" > < li class = "tsd-description" > < aside class = "tsd-sources" > < ul > < li > Defined in < a href = "https://github.com/jamesatjaminit/classcharts-api/blob/48d03a0/src/client.ts#L190" > client.ts:190< / a > < / li > < / ul > < / aside > < div class = "tsd-comment tsd-typography" > < div class = "lead" >
< p > Gets a list of the students badges< / p >
< / div > < / div > < h4 class = "tsd-returns-title" > Returns < span class = "tsd-signature-type" > Promise< / span > < span class = "tsd-signature-symbol" > < < / span > < a href = "../modules/types.html#BadgesResponse" class = "tsd-signature-type" data-tsd-kind = "Type alias" > BadgesResponse< / a > < span class = "tsd-signature-symbol" > > < / span > < / h4 > < div > < p > Array of badges< / p >
< / div > < / li > < / ul > < / section > < section class = "tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class" > < a id = "getBehaviour" class = "tsd-anchor" > < / a > < h3 class = "tsd-anchor-link" > get< wbr / > Behaviour< a href = "#getBehaviour" aria-label = "Permalink" class = "tsd-anchor-icon" > < svg xmlns = "http://www.w3.org/2000/svg" class = "icon icon-tabler icon-tabler-link" viewBox = "0 0 24 24" stroke-width = "2" stroke = "currentColor" fill = "none" stroke-linecap = "round" stroke-linejoin = "round" > < path stroke = "none" d = "M0 0h24v24H0z" fill = "none" > < / path > < path d = "M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5" > < / path > < path d = "M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5" > < / path > < / svg > < / a > < / h3 > < ul class = "tsd-signatures tsd-kind-method tsd-parent-kind-class" > < li class = "tsd-signature tsd-kind-icon" > get< wbr / > Behaviour< span class = "tsd-signature-symbol" > (< / span > options< span class = "tsd-signature-symbol" > ?: < / span > < a href = "../interfaces/types.GetBehaviourOptions.html" class = "tsd-signature-type" data-tsd-kind = "Interface" > GetBehaviourOptions< / a > < span class = "tsd-signature-symbol" > )< / span > < span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > Promise< / span > < span class = "tsd-signature-symbol" > < < / span > < a href = "../modules/types.html#BehaviourResponse" class = "tsd-signature-type" data-tsd-kind = "Type alias" > BehaviourResponse< / a > < span class = "tsd-signature-symbol" > > < / span > < / li > < / ul > < ul class = "tsd-descriptions" > < li class = "tsd-description" > < aside class = "tsd-sources" > < ul > < li > Defined in < a href = "https://github.com/jamesatjaminit/classcharts-api/blob/48d03a0/src/client.ts#L129" > client.ts:129< / a > < / li > < / ul > < / aside > < div class = "tsd-comment tsd-typography" > < div class = "lead" >
2021-10-29 15:46:44 +01:00
< p > Gets the logged in students behaviour points< / p >
2021-11-23 22:23:23 +00:00
< / div > < / div > < h4 class = "tsd-parameters-title" > Parameters< / h4 > < ul class = "tsd-parameters" > < li > < h5 > < span class = "tsd-flag ts-flagOptional" > Optional< / span > options: < a href = "../interfaces/types.GetBehaviourOptions.html" class = "tsd-signature-type" data-tsd-kind = "Interface" > GetBehaviourOptions< / a > < / h5 > < div class = "tsd-comment tsd-typography" > < div class = "lead" >
2021-10-29 15:46:44 +01:00
< p > GetBehaviourOptions< / p >
< / div > < / div > < / li > < / ul > < h4 class = "tsd-returns-title" > Returns < span class = "tsd-signature-type" > Promise< / span > < span class = "tsd-signature-symbol" > < < / span > < a href = "../modules/types.html#BehaviourResponse" class = "tsd-signature-type" data-tsd-kind = "Type alias" > BehaviourResponse< / a > < span class = "tsd-signature-symbol" > > < / span > < / h4 > < div > < p > Array of behaviour points< / p >
2022-01-31 23:20:27 +00:00
< / div > < / li > < / ul > < / section > < section class = "tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class" > < a id = "getLessons" class = "tsd-anchor" > < / a > < h3 class = "tsd-anchor-link" > get< wbr / > Lessons< a href = "#getLessons" aria-label = "Permalink" class = "tsd-anchor-icon" > < svg xmlns = "http://www.w3.org/2000/svg" class = "icon icon-tabler icon-tabler-link" viewBox = "0 0 24 24" stroke-width = "2" stroke = "currentColor" fill = "none" stroke-linecap = "round" stroke-linejoin = "round" > < path stroke = "none" d = "M0 0h24v24H0z" fill = "none" > < / path > < path d = "M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5" > < / path > < path d = "M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5" > < / path > < / svg > < / a > < / h3 > < ul class = "tsd-signatures tsd-kind-method tsd-parent-kind-class" > < li class = "tsd-signature tsd-kind-icon" > get< wbr / > Lessons< span class = "tsd-signature-symbol" > (< / span > options< span class = "tsd-signature-symbol" > ?: < / span > < a href = "../interfaces/types.GetLessonsOptions.html" class = "tsd-signature-type" data-tsd-kind = "Interface" > GetLessonsOptions< / a > < span class = "tsd-signature-symbol" > )< / span > < span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > Promise< / span > < span class = "tsd-signature-symbol" > < < / span > < a href = "../modules/types.html#LessonsResponse" class = "tsd-signature-type" data-tsd-kind = "Type alias" > LessonsResponse< / a > < span class = "tsd-signature-symbol" > > < / span > < / li > < / ul > < ul class = "tsd-descriptions" > < li class = "tsd-description" > < aside class = "tsd-sources" > < ul > < li > Defined in < a href = "https://github.com/jamesatjaminit/classcharts-api/blob/48d03a0/src/client.ts#L175" > client.ts:175< / a > < / li > < / ul > < / aside > < div class = "tsd-comment tsd-typography" > < div class = "lead" >
2021-10-29 15:46:44 +01:00
< p > Gets the logged in student' s lessons for a day< / p >
2021-11-23 22:23:23 +00:00
< / div > < / div > < h4 class = "tsd-parameters-title" > Parameters< / h4 > < ul class = "tsd-parameters" > < li > < h5 > < span class = "tsd-flag ts-flagOptional" > Optional< / span > options: < a href = "../interfaces/types.GetLessonsOptions.html" class = "tsd-signature-type" data-tsd-kind = "Interface" > GetLessonsOptions< / a > < / h5 > < div class = "tsd-comment tsd-typography" > < div class = "lead" >
2021-10-29 15:46:44 +01:00
< p > GetLessonsOptions< / p >
< / div > < / div > < / li > < / ul > < h4 class = "tsd-returns-title" > Returns < span class = "tsd-signature-type" > Promise< / span > < span class = "tsd-signature-symbol" > < < / span > < a href = "../modules/types.html#LessonsResponse" class = "tsd-signature-type" data-tsd-kind = "Type alias" > LessonsResponse< / a > < span class = "tsd-signature-symbol" > > < / span > < / h4 > < div > < p > Array of lessons< / p >
2022-01-31 23:20:27 +00:00
< / div > < / li > < / ul > < / section > < section class = "tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class" > < a id = "getStudentInfo" class = "tsd-anchor" > < / a > < h3 class = "tsd-anchor-link" > get< wbr / > Student< wbr / > Info< a href = "#getStudentInfo" aria-label = "Permalink" class = "tsd-anchor-icon" > < svg xmlns = "http://www.w3.org/2000/svg" class = "icon icon-tabler icon-tabler-link" viewBox = "0 0 24 24" stroke-width = "2" stroke = "currentColor" fill = "none" stroke-linecap = "round" stroke-linejoin = "round" > < path stroke = "none" d = "M0 0h24v24H0z" fill = "none" > < / path > < path d = "M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5" > < / path > < path d = "M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5" > < / path > < / svg > < / a > < / h3 > < ul class = "tsd-signatures tsd-kind-method tsd-parent-kind-class" > < li class = "tsd-signature tsd-kind-icon" > get< wbr / > Student< wbr / > Info< span class = "tsd-signature-symbol" > (< / span > < span class = "tsd-signature-symbol" > )< / span > < span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > Promise< / span > < span class = "tsd-signature-symbol" > < < / span > < a href = "../interfaces/types.Student.html" class = "tsd-signature-type" data-tsd-kind = "Interface" > Student< / a > < span class = "tsd-signature-symbol" > > < / span > < / li > < / ul > < ul class = "tsd-descriptions" > < li class = "tsd-description" > < aside class = "tsd-sources" > < ul > < li > Defined in < a href = "https://github.com/jamesatjaminit/classcharts-api/blob/48d03a0/src/client.ts#L101" > client.ts:101< / a > < / li > < / ul > < / aside > < div class = "tsd-comment tsd-typography" > < div class = "lead" >
2021-10-29 15:46:44 +01:00
< p > Gets general information about the logged in student< / p >
< / div > < / div > < h4 class = "tsd-returns-title" > Returns < span class = "tsd-signature-type" > Promise< / span > < span class = "tsd-signature-symbol" > < < / span > < a href = "../interfaces/types.Student.html" class = "tsd-signature-type" data-tsd-kind = "Interface" > Student< / a > < span class = "tsd-signature-symbol" > > < / span > < / h4 > < div > < p > Student object< / p >
2022-01-31 23:20:27 +00:00
< / div > < / li > < / ul > < / section > < section class = "tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class" > < a id = "listHomeworks" class = "tsd-anchor" > < / a > < h3 class = "tsd-anchor-link" > list< wbr / > Homeworks< a href = "#listHomeworks" aria-label = "Permalink" class = "tsd-anchor-icon" > < svg xmlns = "http://www.w3.org/2000/svg" class = "icon icon-tabler icon-tabler-link" viewBox = "0 0 24 24" stroke-width = "2" stroke = "currentColor" fill = "none" stroke-linecap = "round" stroke-linejoin = "round" > < path stroke = "none" d = "M0 0h24v24H0z" fill = "none" > < / path > < path d = "M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5" > < / path > < path d = "M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5" > < / path > < / svg > < / a > < / h3 > < ul class = "tsd-signatures tsd-kind-method tsd-parent-kind-class" > < li class = "tsd-signature tsd-kind-icon" > list< wbr / > Homeworks< span class = "tsd-signature-symbol" > (< / span > options< span class = "tsd-signature-symbol" > ?: < / span > < a href = "../interfaces/types.GetHomeworkOptions.html" class = "tsd-signature-type" data-tsd-kind = "Interface" > GetHomeworkOptions< / a > < span class = "tsd-signature-symbol" > )< / span > < span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > Promise< / span > < span class = "tsd-signature-symbol" > < < / span > < a href = "../modules/types.html#HomeworksResponse" class = "tsd-signature-type" data-tsd-kind = "Type alias" > HomeworksResponse< / a > < span class = "tsd-signature-symbol" > > < / span > < / li > < / ul > < ul class = "tsd-descriptions" > < li class = "tsd-description" > < aside class = "tsd-sources" > < ul > < li > Defined in < a href = "https://github.com/jamesatjaminit/classcharts-api/blob/48d03a0/src/client.ts#L148" > client.ts:148< / a > < / li > < / ul > < / aside > < div class = "tsd-comment tsd-typography" > < div class = "lead" >
2021-10-29 15:46:44 +01:00
< p > Gets a list of the logged in student' s homeworks< / p >
2021-11-23 22:23:23 +00:00
< / div > < / div > < h4 class = "tsd-parameters-title" > Parameters< / h4 > < ul class = "tsd-parameters" > < li > < h5 > < span class = "tsd-flag ts-flagOptional" > Optional< / span > options: < a href = "../interfaces/types.GetHomeworkOptions.html" class = "tsd-signature-type" data-tsd-kind = "Interface" > GetHomeworkOptions< / a > < / h5 > < div class = "tsd-comment tsd-typography" > < div class = "lead" >
2021-10-29 15:46:44 +01:00
< p > GetHomeworkOptions< / p >
< / div > < / div > < / li > < / ul > < h4 class = "tsd-returns-title" > Returns < span class = "tsd-signature-type" > Promise< / span > < span class = "tsd-signature-symbol" > < < / span > < a href = "../modules/types.html#HomeworksResponse" class = "tsd-signature-type" data-tsd-kind = "Type alias" > HomeworksResponse< / a > < span class = "tsd-signature-symbol" > > < / span > < / h4 > < div > < p > Array of homeworks< / p >
2022-01-31 23:20:27 +00:00
< / div > < / li > < / ul > < / section > < section class = "tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class" > < a id = "login" class = "tsd-anchor" > < / a > < h3 class = "tsd-anchor-link" > login< a href = "#login" aria-label = "Permalink" class = "tsd-anchor-icon" > < svg xmlns = "http://www.w3.org/2000/svg" class = "icon icon-tabler icon-tabler-link" viewBox = "0 0 24 24" stroke-width = "2" stroke = "currentColor" fill = "none" stroke-linecap = "round" stroke-linejoin = "round" > < path stroke = "none" d = "M0 0h24v24H0z" fill = "none" > < / path > < path d = "M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5" > < / path > < path d = "M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5" > < / path > < / svg > < / a > < / h3 > < ul class = "tsd-signatures tsd-kind-method tsd-parent-kind-class" > < li class = "tsd-signature tsd-kind-icon" > login< span class = "tsd-signature-symbol" > (< / span > < span class = "tsd-signature-symbol" > )< / span > < span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > Promise< / span > < span class = "tsd-signature-symbol" > < < / span > < span class = "tsd-signature-type" > void< / span > < span class = "tsd-signature-symbol" > > < / span > < / li > < / ul > < ul class = "tsd-descriptions" > < li class = "tsd-description" > < aside class = "tsd-sources" > < ul > < li > Defined in < a href = "https://github.com/jamesatjaminit/classcharts-api/blob/48d03a0/src/client.ts#L63" > client.ts:63< / a > < / li > < / ul > < / aside > < div class = "tsd-comment tsd-typography" > < div class = "lead" >
< p > Initialises the client and authenticates with classcharts< / p >
< / div > < / div > < h4 class = "tsd-returns-title" > Returns < span class = "tsd-signature-type" > Promise< / span > < span class = "tsd-signature-symbol" > < < / span > < span class = "tsd-signature-type" > void< / span > < span class = "tsd-signature-symbol" > > < / span > < / h4 > < / li > < / ul > < / section > < section class = "tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class" > < a id = "makeAuthedRequest" class = "tsd-anchor" > < / a > < h3 class = "tsd-anchor-link" > make< wbr / > Authed< wbr / > Request< a href = "#makeAuthedRequest" aria-label = "Permalink" class = "tsd-anchor-icon" > < svg xmlns = "http://www.w3.org/2000/svg" class = "icon icon-tabler icon-tabler-link" viewBox = "0 0 24 24" stroke-width = "2" stroke = "currentColor" fill = "none" stroke-linecap = "round" stroke-linejoin = "round" > < path stroke = "none" d = "M0 0h24v24H0z" fill = "none" > < / path > < path d = "M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5" > < / path > < path d = "M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5" > < / path > < / svg > < / a > < / h3 > < ul class = "tsd-signatures tsd-kind-method tsd-parent-kind-class" > < li class = "tsd-signature tsd-kind-icon" > make< wbr / > Authed< wbr / > Request< span class = "tsd-signature-symbol" > (< / span > path< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > string< / span > , options< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > Omit< / span > < span class = "tsd-signature-symbol" > < < / span > < span class = "tsd-signature-type" > RequestOptions< / span > < span class = "tsd-signature-symbol" > , < / span > < span class = "tsd-signature-type" > " origin" < / span > < span class = "tsd-signature-symbol" > | < / span > < span class = "tsd-signature-type" > " path" < / span > < span class = "tsd-signature-symbol" > > < / span > < span class = "tsd-signature-symbol" > )< / span > < span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > Promise< / span > < span class = "tsd-signature-symbol" > < < / span > < span class = "tsd-signature-type" > any< / span > < span class = "tsd-signature-symbol" > > < / span > < / li > < / ul > < ul class = "tsd-descriptions" > < li class = "tsd-description" > < aside class = "tsd-sources" > < ul > < li > Defined in < a href = "https://github.com/jamesatjaminit/classcharts-api/blob/48d03a0/src/client.ts#L36" > client.ts:36< / a > < / li > < / ul > < / aside > < h4 class = "tsd-parameters-title" > Parameters< / h4 > < ul class = "tsd-parameters" > < li > < h5 > path: < span class = "tsd-signature-type" > string< / span > < / h5 > < / li > < li > < h5 > options: < span class = "tsd-signature-type" > Omit< / span > < span class = "tsd-signature-symbol" > < < / span > < span class = "tsd-signature-type" > RequestOptions< / span > < span class = "tsd-signature-symbol" > , < / span > < span class = "tsd-signature-type" > " origin" < / span > < span class = "tsd-signature-symbol" > | < / span > < span class = "tsd-signature-type" > " path" < / span > < span class = "tsd-signature-symbol" > > < / span > < / h5 > < / li > < / ul > < h4 class = "tsd-returns-title" > Returns < span class = "tsd-signature-type" > Promise< / span > < span class = "tsd-signature-symbol" > < < / span > < span class = "tsd-signature-type" > any< / span > < span class = "tsd-signature-symbol" > > < / span > < / h4 > < / li > < / ul > < / 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 = "current 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 = " 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-class tsd-parent-kind-module" > < a href = "client.ClasschartsClient.html" class = "tsd-kind-icon" > Classcharts< wbr / > Client< / a > < ul > < li class = "tsd-kind-constructor tsd-parent-kind-class" > < a href = "client.ClasschartsClient.html#constructor" class = "tsd-kind-icon" > constructor< / a > < / li > < li class = "tsd-kind-property tsd-parent-kind-class tsd-is-private" > < a href = "client.ClasschartsClient.html#authCookies" class = "tsd-kind-icon" > auth< wbr / > Cookies< / a > < / li > < li class = "tsd-kind-property tsd-parent-kind-class" > < a href = "client.ClasschartsClient.html#dateOfBirth" cla
