From 1473c96884122bfde681bb9e40015bb51f1780a3 Mon Sep 17 00:00:00 2001 From: high5-bot Date: Fri, 16 Feb 2024 20:19:31 +0000 Subject: [PATCH] docs: update documentation --- docs/classes/InternalWebuntisSecretLogin.html | 80 +++++++++---------- docs/classes/WebUntis.html | 80 +++++++++---------- docs/classes/WebUntisAnonymousAuth.html | 80 +++++++++---------- docs/classes/WebUntisQR.html | 80 +++++++++---------- docs/classes/WebUntisSecretAuth.html | 80 +++++++++---------- docs/enums/WebUntisDay.html | 4 +- docs/enums/WebUntisElementType.html | 4 +- docs/interfaces/Absence.html | 4 +- docs/interfaces/Absences.html | 4 +- docs/interfaces/CodesEntity.html | 4 +- docs/interfaces/ColorEntity.html | 4 +- docs/interfaces/Department.html | 4 +- docs/interfaces/Exam.html | 4 +- docs/interfaces/Excuse.html | 4 +- docs/interfaces/Holiday.html | 4 +- docs/interfaces/Homework.html | 4 +- docs/interfaces/Inbox.html | 4 +- docs/interfaces/Inboxmessage.html | 4 +- docs/interfaces/Klasse.html | 4 +- docs/interfaces/Lesson.html | 4 +- docs/interfaces/LsEntity.html | 4 +- docs/interfaces/MessagesOfDay.html | 4 +- docs/interfaces/Messagesender.html | 4 +- docs/interfaces/NewsWidget.html | 6 +- docs/interfaces/Room.html | 4 +- docs/interfaces/SchoolYear.html | 4 +- docs/interfaces/ShortData.html | 4 +- docs/interfaces/StatusData.html | 4 +- docs/interfaces/Student.html | 4 +- docs/interfaces/Subject.html | 4 +- docs/interfaces/Teacher.html | 4 +- docs/interfaces/TimeUnit.html | 4 +- docs/interfaces/Timegrid.html | 4 +- docs/interfaces/WebAPITimetable.html | 4 +- docs/interfaces/WebElement.html | 4 +- docs/interfaces/WebElementData.html | 4 +- docs/types/Authenticator.html | 2 +- docs/types/URLClass.html | 2 +- 38 files changed, 265 insertions(+), 265 deletions(-) diff --git a/docs/classes/InternalWebuntisSecretLogin.html b/docs/classes/InternalWebuntisSecretLogin.html index 26eae0d..4c98eb0 100644 --- a/docs/classes/InternalWebuntisSecretLogin.html +++ b/docs/classes/InternalWebuntisSecretLogin.html @@ -1,4 +1,4 @@ -InternalWebuntisSecretLogin | webuntis

Class InternalWebuntisSecretLoginPrivate

Hierarchy (view full)

Constructors

constructor +InternalWebuntisSecretLogin | webuntis

Class InternalWebuntisSecretLoginPrivate

Hierarchy (view full)

Constructors

constructor

Properties

anonymous axios baseurl @@ -52,65 +52,65 @@ convertDateToUntis convertUntisDate convertUntisTime -

Constructors

constructor

Properties

anonymous

anonymous: boolean

axios

axios: AxiosInstance

baseurl

baseurl: string

cookies

cookies: string[]

id

id: string

password

password: string

school

school: string

schoolbase64

schoolbase64: string

sessionInformation

sessionInformation: null | SessionInformation

username

username: string

Static TYPES

TYPES: typeof WebUntisElementType = WebUntisElementType

Methods

Private _buildCookies

Private _getCookieFromSetCookie

  • _getCookieFromSetCookie(setCookieArray?, cookieName?): undefined | string
  • Private

    Parameters

    • Optional setCookieArray: string[]
    • Optional cookieName: string = 'JSESSIONID'

    Returns undefined | string

Private _getJWT

  • _getJWT(validateSession?): Promise<string>
  • Private

    Get JWT Token

    -

    Parameters

    • validateSession: boolean = true

    Returns Promise<string>

_otpLogin

  • _otpLogin(token, username, time, skipSessionInfo?): Promise<SessionInformation>

  • Parameters

    • token: string | number
    • username: string
    • time: number
    • skipSessionInfo: boolean = false

    Returns Promise<SessionInformation>

Private _request

  • _request<Response>(method, parameter?, validateSession?, url?): Promise<Response>
  • Private

    Make a JSON RPC Request with the current session

    +

Constructors

constructor

Properties

anonymous

anonymous: boolean

axios

axios: AxiosInstance

baseurl

baseurl: string

cookies

cookies: string[]

id

id: string

password

password: string

school

school: string

schoolbase64

schoolbase64: string

sessionInformation

sessionInformation: null | SessionInformation

username

username: string

Static TYPES

TYPES: typeof WebUntisElementType = WebUntisElementType

Methods

Private _buildCookies

Private _getCookieFromSetCookie

  • _getCookieFromSetCookie(setCookieArray?, cookieName?): undefined | string
  • Private

    Parameters

    • Optional setCookieArray: string[]
    • Optional cookieName: string = 'JSESSIONID'

    Returns undefined | string

Private _getJWT

  • _getJWT(validateSession?): Promise<string>
  • Private

    Get JWT Token

    +

    Parameters

    • validateSession: boolean = true

    Returns Promise<string>

_otpLogin

  • _otpLogin(token, username, time, skipSessionInfo?): Promise<SessionInformation>

  • Parameters

    • token: string | number
    • username: string
    • time: number
    • skipSessionInfo: boolean = false

    Returns Promise<SessionInformation>

Private _request

  • _request<Response>(method, parameter?, validateSession?, url?): Promise<Response>
  • Private

    Make a JSON RPC Request with the current session

    Type Parameters

    • Response = Record<string, any>

    Parameters

    • method: string
    • Optional parameter: Record<string, any> = {}
    • Optional validateSession: boolean = true

      Whether the session should be checked first

      -
    • Optional url: string = ...

    Returns Promise<Response>

getAbsentLesson

  • getAbsentLesson(rangeStart, rangeEnd, excuseStatusId?, validateSession?): Promise<Absences>

  • Returns all the Lessons where you were absent including the excused one!

    -

    Parameters

    • rangeStart: Date
    • rangeEnd: Date
    • Optional excuseStatusId: number = -1
    • Optional validateSession: boolean = true

    Returns Promise<Absences>

getClasses

  • getClasses(validateSession?, schoolyearId): Promise<Klasse[]>

  • Get all classes known by WebUntis

    -

    Parameters

    • Optional validateSession: boolean = true
    • schoolyearId: number

    Returns Promise<Klasse[]>

getCurrentSchoolyear

getDepartments

getExamsForRange

  • getExamsForRange(rangeStart, rangeEnd, klasseId?, withGrades?, validateSession?): Promise<Exam[]>

  • Get Exams for range

    -

    Parameters

    • rangeStart: Date
    • rangeEnd: Date
    • klasseId: number = -1
    • withGrades: boolean = false
    • Optional validateSession: boolean = true

    Returns Promise<Exam[]>

getHolidays

getHomeWorkAndLessons

  • getHomeWorkAndLessons(rangeStart, rangeEnd, validateSession?): Promise<any[]>

  • TODO: Find out what type this function returns

    -

    Parameters

    • rangeStart: Date
    • rangeEnd: Date
    • Optional validateSession: boolean = true

    Returns Promise<any[]>

getHomeWorksFor

getInbox

getLatestImportTime

  • getLatestImportTime(validateSession?): Promise<number>

  • Get the time when WebUntis last changed its data

    -

    Parameters

    • Optional validateSession: boolean = true

    Returns Promise<number>

getLatestSchoolyear

getNewsWidget

  • getNewsWidget(date, validateSession?): Promise<NewsWidget>

  • Get News Widget

    +
  • Optional url: string = ...

Returns Promise<Response>

getAbsentLesson

  • getAbsentLesson(rangeStart, rangeEnd, excuseStatusId?, validateSession?): Promise<Absences>

  • Returns all the Lessons where you were absent including the excused one!

    +

    Parameters

    • rangeStart: Date
    • rangeEnd: Date
    • Optional excuseStatusId: number = -1
    • Optional validateSession: boolean = true

    Returns Promise<Absences>

getClasses

  • getClasses(validateSession?, schoolyearId): Promise<Klasse[]>

  • Get all classes known by WebUntis

    +

    Parameters

    • Optional validateSession: boolean = true
    • schoolyearId: number

    Returns Promise<Klasse[]>

getCurrentSchoolyear

getDepartments

getExamsForRange

  • getExamsForRange(rangeStart, rangeEnd, klasseId?, withGrades?, validateSession?): Promise<Exam[]>

  • Get Exams for range

    +

    Parameters

    • rangeStart: Date
    • rangeEnd: Date
    • klasseId: number = -1
    • withGrades: boolean = false
    • Optional validateSession: boolean = true

    Returns Promise<Exam[]>

getHolidays

getHomeWorkAndLessons

  • getHomeWorkAndLessons(rangeStart, rangeEnd, validateSession?): Promise<any[]>

  • TODO: Find out what type this function returns

    +

    Parameters

    • rangeStart: Date
    • rangeEnd: Date
    • Optional validateSession: boolean = true

    Returns Promise<any[]>

getHomeWorksFor

getInbox

getLatestImportTime

  • getLatestImportTime(validateSession?): Promise<number>

  • Get the time when WebUntis last changed its data

    +

    Parameters

    • Optional validateSession: boolean = true

    Returns Promise<number>

getLatestSchoolyear

getNewsWidget

getOwnClassTimetableFor

getOwnClassTimetableFor

  • getOwnClassTimetableFor(date, validateSession?): Promise<Lesson[]>

  • Get the Timetable of your class for the given day Note: You can't use this with anonymous login

    -

    Parameters

    • date: Date
    • Optional validateSession: boolean = true

    Returns Promise<Lesson[]>

getOwnClassTimetableForRange

  • getOwnClassTimetableForRange(rangeStart, rangeEnd, validateSession?): Promise<Lesson[]>

  • Get the Timetable of your class for a given Date range +

    Parameters

    • date: Date
    • Optional validateSession: boolean = true

    Returns Promise<Lesson[]>

getOwnClassTimetableForRange

  • getOwnClassTimetableForRange(rangeStart, rangeEnd, validateSession?): Promise<Lesson[]>

  • Get the Timetable of your class for a given Date range Note: You can't use this with anonymous login

    -

    Parameters

    • rangeStart: Date
    • rangeEnd: Date
    • Optional validateSession: boolean = true

    Returns Promise<Lesson[]>

getOwnClassTimetableForToday

getOwnClassTimetableForToday

  • getOwnClassTimetableForToday(validateSession?): Promise<Lesson[]>

  • Get the Timetable of your class for today Note: You can't use this with anonymous login

    -

    Parameters

    • Optional validateSession: boolean = true

    Returns Promise<Lesson[]>

getOwnTimetableFor

getOwnTimetableFor

  • getOwnTimetableFor(date, validateSession?): Promise<Lesson[]>

  • Get your own Timetable for the given day Note: You can't use this with anonymous login

    -

    Parameters

    • date: Date
    • Optional validateSession: boolean = true

    Returns Promise<Lesson[]>

getOwnTimetableForRange

  • getOwnTimetableForRange(rangeStart, rangeEnd, validateSession?): Promise<Lesson[]>

  • Get your own timetable for a given Date range +

    Parameters

    • date: Date
    • Optional validateSession: boolean = true

    Returns Promise<Lesson[]>

getOwnTimetableForRange

  • getOwnTimetableForRange(rangeStart, rangeEnd, validateSession?): Promise<Lesson[]>

  • Get your own timetable for a given Date range Note: You can't use this with anonymous login

    -

    Parameters

    • rangeStart: Date
    • rangeEnd: Date
    • Optional validateSession: boolean = true

    Returns Promise<Lesson[]>

getOwnTimetableForToday

  • getOwnTimetableForToday(validateSession?): Promise<Lesson[]>

  • Get your own Timetable for the current day +

    Parameters

    • rangeStart: Date
    • rangeEnd: Date
    • Optional validateSession: boolean = true

    Returns Promise<Lesson[]>

getOwnTimetableForToday

  • getOwnTimetableForToday(validateSession?): Promise<Lesson[]>

  • Get your own Timetable for the current day Note: You can't use this with anonymous login

    -

    Parameters

    • Optional validateSession: boolean = true

    Returns Promise<Lesson[]>

getOwnTimetableForWeek

  • getOwnTimetableForWeek(date, formatId?, validateSession?): Promise<WebAPITimetable[]>

  • Get the timetable for the current week for the current element from the web client API.

    +

    Parameters

    • Optional validateSession: boolean = true

    Returns Promise<Lesson[]>

getOwnTimetableForWeek

  • getOwnTimetableForWeek(date, formatId?, validateSession?): Promise<WebAPITimetable[]>

  • Get the timetable for the current week for the current element from the web client API.

    Parameters

    • date: Date

      one date in the week to query

    • Optional formatId: number = 1

      set to 1 to include teachers, 2 omits the teachers in elements response

      -
    • Optional validateSession: boolean = true

    Returns Promise<WebAPITimetable[]>

getPdfOfAbsentLesson

  • getPdfOfAbsentLesson(rangeStart, rangeEnd, validateSession?, excuseStatusId?, lateness?, absences?, excuseGroup?): Promise<string>

  • Returns a URL to a unique PDF of all the lessons you were absent

    -

    Parameters

    • rangeStart: Date
    • rangeEnd: Date
    • Optional validateSession: boolean = true
    • Optional excuseStatusId: number = -1
    • Optional lateness: boolean = true
    • Optional absences: boolean = true
    • Optional excuseGroup: number = 2

    Returns Promise<string>

getRooms

  • getRooms(validateSession?): Promise<Room[]>

  • Get all known rooms by WebUntis

    -

    Parameters

    • Optional validateSession: boolean = true

    Returns Promise<Room[]>

getSchoolyears

getStatusData

getStudents

getSubjects

  • getSubjects(validateSession?): Promise<Subject[]>

  • Get all known Subjects for the current logged-in user

    -

    Parameters

    • Optional validateSession: boolean = true

    Returns Promise<Subject[]>

getTeachers

getTimegrid

getTimetableFor

  • getTimetableFor(date, id, type, validateSession?): Promise<Lesson[]>

  • Get the timetable for a specific day for a specific element.

    -

    Parameters

    • date: Date
    • id: number
    • type: number
    • Optional validateSession: boolean = true

    Returns Promise<Lesson[]>

getTimetableForRange

  • getTimetableForRange(rangeStart, rangeEnd, id, type, validateSession?): Promise<Lesson[]>

  • Get the timetable for a given Date range for specific element

    -

    Parameters

    • rangeStart: Date
    • rangeEnd: Date
    • id: number
    • type: number
    • Optional validateSession: boolean = true

    Returns Promise<Lesson[]>

getTimetableForToday

  • getTimetableForToday(id, type, validateSession?): Promise<Lesson[]>

  • Get the timetable of today for a specific element.

    -

    Parameters

    • id: number
    • type: number
    • Optional validateSession: boolean = true

    Returns Promise<Lesson[]>

getTimetableForWeek

  • getTimetableForWeek(date, id, type, formatId?, validateSession?): Promise<WebAPITimetable[]>

  • Get the timetable for the current week for a specific element from the web client API.

    +
  • Optional validateSession: boolean = true

Returns Promise<WebAPITimetable[]>

getPdfOfAbsentLesson

getRooms

getSchoolyears

getStatusData

getStudents

getSubjects

getTeachers

getTimegrid

getTimetableFor

getTimetableForRange

getTimetableForToday

getTimetableForWeek

login

Returns Promise<WebAPITimetable[]>

login

logout

validateSession

Static convertDateToUntis

Static convertUntisDate

logout

validateSession

Static convertDateToUntis

Static convertUntisDate

Static convertUntisTime

Returns Date

Static

Static convertUntisTime

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Returns Date

Static

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/classes/WebUntis.html b/docs/classes/WebUntis.html index 179ed42..648ab97 100644 --- a/docs/classes/WebUntis.html +++ b/docs/classes/WebUntis.html @@ -1,4 +1,4 @@ -WebUntis | webuntis

Class WebUntis

Hierarchy (view full)

Constructors

constructor +WebUntis | webuntis

Class WebUntis

Hierarchy (view full)

Constructors

constructor

Properties

anonymous axios baseurl @@ -56,65 +56,65 @@
  • username: string
  • password: string
  • baseurl: string

    Just the host name of your WebUntis (Example: mese.webuntis.com)

  • Optional identity: string = 'Awesome'

    A identity like: MyAwesomeApp

  • Optional disableUserAgent: boolean = false

    If this is true, axios will not send a custom User-Agent

    -

    • Returns WebUntis

    Properties

    anonymous

    anonymous: boolean

    axios

    axios: AxiosInstance

    baseurl

    baseurl: string

    cookies

    cookies: string[]

    id

    id: string

    password

    password: string

    school

    school: string

    schoolbase64

    schoolbase64: string

    sessionInformation

    sessionInformation: null | SessionInformation

    username

    username: string

    Static TYPES

    TYPES: typeof WebUntisElementType = WebUntisElementType

    Methods

    Private _buildCookies

    • _buildCookies(): string
    • Private

      Returns string

    Private _checkAnonymous

    • _checkAnonymous(): void

    • Returns void

    Private _getJWT

    • _getJWT(validateSession?): Promise<string>
    • Private

      Get JWT Token

      -

      Parameters

      • validateSession: boolean = true

      Returns Promise<string>

    Private _request

    • _request<Response>(method, parameter?, validateSession?, url?): Promise<Response>
    • Private

      Make a JSON RPC Request with the current session

      +

    Returns WebUntis

    Properties

    anonymous

    anonymous: boolean

    axios

    axios: AxiosInstance

    baseurl

    baseurl: string

    cookies

    cookies: string[]

    id

    id: string

    password

    password: string

    school

    school: string

    schoolbase64

    schoolbase64: string

    sessionInformation

    sessionInformation: null | SessionInformation

    username

    username: string

    Static TYPES

    TYPES: typeof WebUntisElementType = WebUntisElementType

    Methods

    Private _buildCookies

    • _buildCookies(): string
    • Private

      Returns string

    Private _checkAnonymous

    • _checkAnonymous(): void

    • Returns void

    Private _getJWT

    • _getJWT(validateSession?): Promise<string>
    • Private

      Get JWT Token

      +

      Parameters

      • validateSession: boolean = true

      Returns Promise<string>

    Private _request

    • _request<Response>(method, parameter?, validateSession?, url?): Promise<Response>
    • Private

      Make a JSON RPC Request with the current session

      Type Parameters

      • Response = Record<string, any>

      Parameters

      • method: string
      • Optional parameter: Record<string, any> = {}
      • Optional validateSession: boolean = true

        Whether the session should be checked first

        -
      • Optional url: string = ...

      Returns Promise<Response>

    Private _timetableRequest

    • _timetableRequest(id, type, startDate?, endDate?, validateSession?): Promise<Lesson[]>
    • Private

      Parameters

      • id: string | number
      • type: number
      • Optional startDate: null | Date
      • Optional endDate: null | Date
      • validateSession: boolean = true

      Returns Promise<Lesson[]>

    getAbsentLesson

    • getAbsentLesson(rangeStart, rangeEnd, excuseStatusId?, validateSession?): Promise<Absences>

    • Returns all the Lessons where you were absent including the excused one!

      -

      Parameters

      • rangeStart: Date
      • rangeEnd: Date
      • Optional excuseStatusId: number = -1
      • Optional validateSession: boolean = true

      Returns Promise<Absences>

    getClasses

    • getClasses(validateSession?, schoolyearId): Promise<Klasse[]>

    • Get all classes known by WebUntis

      -

      Parameters

      • Optional validateSession: boolean = true
      • schoolyearId: number

      Returns Promise<Klasse[]>

    getCurrentSchoolyear

    • getCurrentSchoolyear(validateSession?): Promise<SchoolYear>

    • Get the current school year

      -

      Parameters

      • Optional validateSession: boolean = true

      Returns Promise<SchoolYear>

    getDepartments

    • getDepartments(validateSession?): Promise<Department[]>

    • Get all departments known by WebUntis

      -

      Parameters

      • Optional validateSession: boolean = true

      Returns Promise<Department[]>

    getExamsForRange

    • getExamsForRange(rangeStart, rangeEnd, klasseId?, withGrades?, validateSession?): Promise<Exam[]>

    • Get Exams for range

      -

      Parameters

      • rangeStart: Date
      • rangeEnd: Date
      • klasseId: number = -1
      • withGrades: boolean = false
      • Optional validateSession: boolean = true

      Returns Promise<Exam[]>

    getHolidays

    • getHolidays(validateSession?): Promise<Holiday[]>

    • Get all holidays known by WebUntis

      -

      Parameters

      • Optional validateSession: boolean = true

      Returns Promise<Holiday[]>

    getHomeWorkAndLessons

    • getHomeWorkAndLessons(rangeStart, rangeEnd, validateSession?): Promise<any[]>

    • TODO: Find out what type this function returns

      -

      Parameters

      • rangeStart: Date
      • rangeEnd: Date
      • Optional validateSession: boolean = true

      Returns Promise<any[]>

    getHomeWorksFor

    • getHomeWorksFor(rangeStart, rangeEnd, validateSession?): Promise<Homework[]>

    • Parameters

      • rangeStart: Date
      • rangeEnd: Date
      • Optional validateSession: boolean = true

      Returns Promise<Homework[]>

    getInbox

    • getInbox(validateSession?): Promise<Inbox>

    • Get Inbox

      -

      Parameters

      • validateSession: boolean = true

      Returns Promise<Inbox>

    getLatestImportTime

    • getLatestImportTime(validateSession?): Promise<number>

    • Get the time when WebUntis last changed its data

      -

      Parameters

      • Optional validateSession: boolean = true

      Returns Promise<number>

    getLatestSchoolyear

    • getLatestSchoolyear(validateSession?): Promise<SchoolYear>

    • Get the latest WebUntis Schoolyear

      -

      Parameters

      • Optional validateSession: boolean = true

      Returns Promise<SchoolYear>

    getNewsWidget

    • getNewsWidget(date, validateSession?): Promise<NewsWidget>

    • Get News Widget

      +
    • Optional url: string = ...

    Returns Promise<Response>

    Private _timetableRequest

    • _timetableRequest(id, type, startDate?, endDate?, validateSession?): Promise<Lesson[]>
    • Private

      Parameters

      • id: string | number
      • type: number
      • Optional startDate: null | Date
      • Optional endDate: null | Date
      • validateSession: boolean = true

      Returns Promise<Lesson[]>

    getAbsentLesson

    • getAbsentLesson(rangeStart, rangeEnd, excuseStatusId?, validateSession?): Promise<Absences>

    • Returns all the Lessons where you were absent including the excused one!

      +

      Parameters

      • rangeStart: Date
      • rangeEnd: Date
      • Optional excuseStatusId: number = -1
      • Optional validateSession: boolean = true

      Returns Promise<Absences>

    getClasses

    • getClasses(validateSession?, schoolyearId): Promise<Klasse[]>

    • Get all classes known by WebUntis

      +

      Parameters

      • Optional validateSession: boolean = true
      • schoolyearId: number

      Returns Promise<Klasse[]>

    getCurrentSchoolyear

    • getCurrentSchoolyear(validateSession?): Promise<SchoolYear>

    • Get the current school year

      +

      Parameters

      • Optional validateSession: boolean = true

      Returns Promise<SchoolYear>

    getDepartments

    • getDepartments(validateSession?): Promise<Department[]>

    • Get all departments known by WebUntis

      +

      Parameters

      • Optional validateSession: boolean = true

      Returns Promise<Department[]>

    getExamsForRange

    • getExamsForRange(rangeStart, rangeEnd, klasseId?, withGrades?, validateSession?): Promise<Exam[]>

    • Get Exams for range

      +

      Parameters

      • rangeStart: Date
      • rangeEnd: Date
      • klasseId: number = -1
      • withGrades: boolean = false
      • Optional validateSession: boolean = true

      Returns Promise<Exam[]>

    getHolidays

    • getHolidays(validateSession?): Promise<Holiday[]>

    • Get all holidays known by WebUntis

      +

      Parameters

      • Optional validateSession: boolean = true

      Returns Promise<Holiday[]>

    getHomeWorkAndLessons

    • getHomeWorkAndLessons(rangeStart, rangeEnd, validateSession?): Promise<any[]>

    • TODO: Find out what type this function returns

      +

      Parameters

      • rangeStart: Date
      • rangeEnd: Date
      • Optional validateSession: boolean = true

      Returns Promise<any[]>

    getHomeWorksFor

    • getHomeWorksFor(rangeStart, rangeEnd, validateSession?): Promise<Homework[]>

    • Parameters

      • rangeStart: Date
      • rangeEnd: Date
      • Optional validateSession: boolean = true

      Returns Promise<Homework[]>

    getInbox

    • getInbox(validateSession?): Promise<Inbox>

    • Get Inbox

      +

      Parameters

      • validateSession: boolean = true

      Returns Promise<Inbox>

    getLatestImportTime

    • getLatestImportTime(validateSession?): Promise<number>

    • Get the time when WebUntis last changed its data

      +

      Parameters

      • Optional validateSession: boolean = true

      Returns Promise<number>

    getLatestSchoolyear

    • getLatestSchoolyear(validateSession?): Promise<SchoolYear>

    • Get the latest WebUntis Schoolyear

      +

      Parameters

      • Optional validateSession: boolean = true

      Returns Promise<SchoolYear>

    getNewsWidget

    • getNewsWidget(date, validateSession?): Promise<NewsWidget>

    • Get News Widget

      Parameters

      • date: Date
      • Optional validateSession: boolean = true

      Returns Promise<NewsWidget>

      see index.d.ts NewsWidget

      -

    getOwnClassTimetableFor

    • getOwnClassTimetableFor(date, validateSession?): Promise<Lesson[]>

    • Get the Timetable of your class for the given day +

    getOwnClassTimetableFor

    • getOwnClassTimetableFor(date, validateSession?): Promise<Lesson[]>

    • Get the Timetable of your class for the given day Note: You can't use this with anonymous login

      -

      Parameters

      • date: Date
      • Optional validateSession: boolean = true

      Returns Promise<Lesson[]>

    getOwnClassTimetableForRange

    • getOwnClassTimetableForRange(rangeStart, rangeEnd, validateSession?): Promise<Lesson[]>

    • Get the Timetable of your class for a given Date range +

      Parameters

      • date: Date
      • Optional validateSession: boolean = true

      Returns Promise<Lesson[]>

    getOwnClassTimetableForRange

    • getOwnClassTimetableForRange(rangeStart, rangeEnd, validateSession?): Promise<Lesson[]>

    • Get the Timetable of your class for a given Date range Note: You can't use this with anonymous login

      -

      Parameters

      • rangeStart: Date
      • rangeEnd: Date
      • Optional validateSession: boolean = true

      Returns Promise<Lesson[]>

    getOwnClassTimetableForToday

    • getOwnClassTimetableForToday(validateSession?): Promise<Lesson[]>

    • Get the Timetable of your class for today +

      Parameters

      • rangeStart: Date
      • rangeEnd: Date
      • Optional validateSession: boolean = true

      Returns Promise<Lesson[]>

    getOwnClassTimetableForToday

    • getOwnClassTimetableForToday(validateSession?): Promise<Lesson[]>

    • Get the Timetable of your class for today Note: You can't use this with anonymous login

      -

      Parameters

      • Optional validateSession: boolean = true

      Returns Promise<Lesson[]>

    getOwnTimetableFor

    • getOwnTimetableFor(date, validateSession?): Promise<Lesson[]>

    • Get your own Timetable for the given day +

      Parameters

      • Optional validateSession: boolean = true

      Returns Promise<Lesson[]>

    getOwnTimetableFor

    • getOwnTimetableFor(date, validateSession?): Promise<Lesson[]>

    • Get your own Timetable for the given day Note: You can't use this with anonymous login

      -

      Parameters

      • date: Date
      • Optional validateSession: boolean = true

      Returns Promise<Lesson[]>

    getOwnTimetableForRange

    • getOwnTimetableForRange(rangeStart, rangeEnd, validateSession?): Promise<Lesson[]>

    • Get your own timetable for a given Date range +

      Parameters

      • date: Date
      • Optional validateSession: boolean = true

      Returns Promise<Lesson[]>

    getOwnTimetableForRange

    • getOwnTimetableForRange(rangeStart, rangeEnd, validateSession?): Promise<Lesson[]>

    • Get your own timetable for a given Date range Note: You can't use this with anonymous login

      -

      Parameters

      • rangeStart: Date
      • rangeEnd: Date
      • Optional validateSession: boolean = true

      Returns Promise<Lesson[]>

    getOwnTimetableForToday

    • getOwnTimetableForToday(validateSession?): Promise<Lesson[]>

    • Get your own Timetable for the current day +

      Parameters

      • rangeStart: Date
      • rangeEnd: Date
      • Optional validateSession: boolean = true

      Returns Promise<Lesson[]>

    getOwnTimetableForToday

    • getOwnTimetableForToday(validateSession?): Promise<Lesson[]>

    • Get your own Timetable for the current day Note: You can't use this with anonymous login

      -

      Parameters

      • Optional validateSession: boolean = true

      Returns Promise<Lesson[]>

    getOwnTimetableForWeek

    • getOwnTimetableForWeek(date, formatId?, validateSession?): Promise<WebAPITimetable[]>

    • Get the timetable for the current week for the current element from the web client API.

      +

      Parameters

      • Optional validateSession: boolean = true

      Returns Promise<Lesson[]>

    getOwnTimetableForWeek

    • getOwnTimetableForWeek(date, formatId?, validateSession?): Promise<WebAPITimetable[]>

    • Get the timetable for the current week for the current element from the web client API.

      Parameters

      • date: Date

        one date in the week to query

      • Optional formatId: number = 1

        set to 1 to include teachers, 2 omits the teachers in elements response

        -
      • Optional validateSession: boolean = true

      Returns Promise<WebAPITimetable[]>

    getPdfOfAbsentLesson

    • getPdfOfAbsentLesson(rangeStart, rangeEnd, validateSession?, excuseStatusId?, lateness?, absences?, excuseGroup?): Promise<string>

    • Returns a URL to a unique PDF of all the lessons you were absent

      -

      Parameters

      • rangeStart: Date
      • rangeEnd: Date
      • Optional validateSession: boolean = true
      • Optional excuseStatusId: number = -1
      • Optional lateness: boolean = true
      • Optional absences: boolean = true
      • Optional excuseGroup: number = 2

      Returns Promise<string>

    getRooms

    • getRooms(validateSession?): Promise<Room[]>

    • Get all known rooms by WebUntis

      -

      Parameters

      • Optional validateSession: boolean = true

      Returns Promise<Room[]>

    getSchoolyears

    • getSchoolyears(validateSession?): Promise<SchoolYear[]>

    • Get all WebUntis Schoolyears

      -

      Parameters

      • Optional validateSession: boolean = true

      Returns Promise<SchoolYear[]>

    getStatusData

    • getStatusData(validateSession?): Promise<StatusData>

    • Get all status data known by WebUntis

      -

      Parameters

      • Optional validateSession: boolean = true

      Returns Promise<StatusData>

    getStudents

    • getStudents(validateSession?): Promise<Student[]>

    • Get all known students by WebUntis

      -

      Parameters

      • Optional validateSession: boolean = true

      Returns Promise<Student[]>

    getSubjects

    • getSubjects(validateSession?): Promise<Subject[]>

    • Get all known Subjects for the current logged-in user

      -

      Parameters

      • Optional validateSession: boolean = true

      Returns Promise<Subject[]>

    getTeachers

    • getTeachers(validateSession?): Promise<Teacher[]>

    • Get all known teachers by WebUntis

      -

      Parameters

      • Optional validateSession: boolean = true

      Returns Promise<Teacher[]>

    getTimegrid

    • getTimegrid(validateSession?): Promise<Timegrid[]>

    • Get the timegrid of current school

      -

      Parameters

      • Optional validateSession: boolean = true

      Returns Promise<Timegrid[]>

    getTimetableFor

    • getTimetableFor(date, id, type, validateSession?): Promise<Lesson[]>

    • Get the timetable for a specific day for a specific element.

      -

      Parameters

      • date: Date
      • id: number
      • type: number
      • Optional validateSession: boolean = true

      Returns Promise<Lesson[]>

    getTimetableForRange

    • getTimetableForRange(rangeStart, rangeEnd, id, type, validateSession?): Promise<Lesson[]>

    • Get the timetable for a given Date range for specific element

      -

      Parameters

      • rangeStart: Date
      • rangeEnd: Date
      • id: number
      • type: number
      • Optional validateSession: boolean = true

      Returns Promise<Lesson[]>

    getTimetableForToday

    • getTimetableForToday(id, type, validateSession?): Promise<Lesson[]>

    • Get the timetable of today for a specific element.

      -

      Parameters

      • id: number
      • type: number
      • Optional validateSession: boolean = true

      Returns Promise<Lesson[]>

    getTimetableForWeek

    • getTimetableForWeek(date, id, type, formatId?, validateSession?): Promise<WebAPITimetable[]>

    • Get the timetable for the current week for a specific element from the web client API.

      +
    • Optional validateSession: boolean = true

    Returns Promise<WebAPITimetable[]>

    getPdfOfAbsentLesson

    getRooms

    getSchoolyears

    getStatusData

    getStudents

    getSubjects

    getTeachers

    getTimegrid

    getTimetableFor

    getTimetableForRange

    getTimetableForToday

    getTimetableForWeek

    login

    Returns Promise<WebAPITimetable[]>

    login

    logout

    validateSession

    Static convertDateToUntis

    Static convertUntisDate

    logout

    validateSession

    Static convertDateToUntis

    Static convertUntisDate

    Static convertUntisTime

    Returns Date

    Static

    Static convertUntisTime

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Returns Date

    Static

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/classes/WebUntisAnonymousAuth.html b/docs/classes/WebUntisAnonymousAuth.html index 46c5026..61839c0 100644 --- a/docs/classes/WebUntisAnonymousAuth.html +++ b/docs/classes/WebUntisAnonymousAuth.html @@ -1,4 +1,4 @@ -WebUntisAnonymousAuth | webuntis

    Class WebUntisAnonymousAuth

    Hierarchy (view full)

    Constructors

    constructor +WebUntisAnonymousAuth | webuntis

    Class WebUntisAnonymousAuth

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    anonymous axios baseurl @@ -53,65 +53,65 @@ convertUntisDate convertUntisTime

    Constructors

    constructor

    Properties

    anonymous

    anonymous: boolean

    axios

    axios: AxiosInstance

    baseurl

    baseurl: string

    cookies

    cookies: string[]

    id

    id: string

    password

    password: string

    school

    school: string

    schoolbase64

    schoolbase64: string

    sessionInformation

    sessionInformation: null | SessionInformation

    username

    username: string

    Static TYPES

    TYPES: typeof WebUntisElementType = WebUntisElementType

    Methods

    Private _buildCookies

    Private _getCookieFromSetCookie

    Private _getJWT

    _otpLogin

    • _otpLogin(token, username, time, skipSessionInfo?): Promise<SessionInformation>

    • Parameters

      • token: string | number
      • username: string
      • time: number
      • skipSessionInfo: boolean = false

      Returns Promise<SessionInformation>

    Private _request

    • _request<Response>(method, parameter?, validateSession?, url?): Promise<Response>
    • Private

      Make a JSON RPC Request with the current session

      +

    Returns WebUntisAnonymousAuth

    Properties

    anonymous

    anonymous: boolean

    axios

    axios: AxiosInstance

    baseurl

    baseurl: string

    cookies

    cookies: string[]

    id

    id: string

    password

    password: string

    school

    school: string

    schoolbase64

    schoolbase64: string

    sessionInformation

    sessionInformation: null | SessionInformation

    username

    username: string

    Static TYPES

    TYPES: typeof WebUntisElementType = WebUntisElementType

    Methods

    Private _buildCookies

    Private _getCookieFromSetCookie

    Private _getJWT

    _otpLogin

    • _otpLogin(token, username, time, skipSessionInfo?): Promise<SessionInformation>

    • Parameters

      • token: string | number
      • username: string
      • time: number
      • skipSessionInfo: boolean = false

      Returns Promise<SessionInformation>

    Private _request

    • _request<Response>(method, parameter?, validateSession?, url?): Promise<Response>
    • Private

      Make a JSON RPC Request with the current session

      Type Parameters

      • Response = Record<string, any>

      Parameters

      • method: string
      • Optional parameter: Record<string, any> = {}
      • Optional validateSession: boolean = true

        Whether the session should be checked first

        -
      • Optional url: string = ...

      Returns Promise<Response>

    getAbsentLesson

    • getAbsentLesson(rangeStart, rangeEnd, excuseStatusId?, validateSession?): Promise<Absences>

    • Returns all the Lessons where you were absent including the excused one!

      -

      Parameters

      • rangeStart: Date
      • rangeEnd: Date
      • Optional excuseStatusId: number = -1
      • Optional validateSession: boolean = true

      Returns Promise<Absences>

    getClasses

    getCurrentSchoolyear

    getDepartments

    getExamsForRange

    • getExamsForRange(rangeStart, rangeEnd, klasseId?, withGrades?, validateSession?): Promise<Exam[]>

    • Get Exams for range

      -

      Parameters

      • rangeStart: Date
      • rangeEnd: Date
      • klasseId: number = -1
      • withGrades: boolean = false
      • Optional validateSession: boolean = true

      Returns Promise<Exam[]>

    getHolidays

    getHomeWorkAndLessons

    • getHomeWorkAndLessons(rangeStart, rangeEnd, validateSession?): Promise<any[]>

    • TODO: Find out what type this function returns

      -

      Parameters

      • rangeStart: Date
      • rangeEnd: Date
      • Optional validateSession: boolean = true

      Returns Promise<any[]>

    getHomeWorksFor

    getInbox

    getLatestImportTime

    getLatestSchoolyear

    getNewsWidget

    • getNewsWidget(date, validateSession?): Promise<NewsWidget>

    • Get News Widget

      +
    • Optional url: string = ...

    Returns Promise<Response>

    getAbsentLesson

    • getAbsentLesson(rangeStart, rangeEnd, excuseStatusId?, validateSession?): Promise<Absences>

    • Returns all the Lessons where you were absent including the excused one!

      +

      Parameters

      • rangeStart: Date
      • rangeEnd: Date
      • Optional excuseStatusId: number = -1
      • Optional validateSession: boolean = true

      Returns Promise<Absences>

    getClasses

    getCurrentSchoolyear

    getDepartments

    getExamsForRange

    • getExamsForRange(rangeStart, rangeEnd, klasseId?, withGrades?, validateSession?): Promise<Exam[]>

    • Get Exams for range

      +

      Parameters

      • rangeStart: Date
      • rangeEnd: Date
      • klasseId: number = -1
      • withGrades: boolean = false
      • Optional validateSession: boolean = true

      Returns Promise<Exam[]>

    getHolidays

    getHomeWorkAndLessons

    • getHomeWorkAndLessons(rangeStart, rangeEnd, validateSession?): Promise<any[]>

    • TODO: Find out what type this function returns

      +

      Parameters

      • rangeStart: Date
      • rangeEnd: Date
      • Optional validateSession: boolean = true

      Returns Promise<any[]>

    getHomeWorksFor

    getInbox

    getLatestImportTime

    getLatestSchoolyear

    getNewsWidget

    getOwnClassTimetableFor

    getOwnClassTimetableFor

    getOwnClassTimetableForRange

    getOwnClassTimetableForRange

    getOwnClassTimetableForToday

    getOwnClassTimetableForToday

    getOwnTimetableFor

    getOwnTimetableFor

    getOwnTimetableForRange

    getOwnTimetableForRange

    • getOwnTimetableForRange(rangeStart, rangeEnd, validateSession?): Promise<Lesson[]>

    • Get your own timetable for a given Date range Note: You can't use this with anonymous login

      -

      Parameters

      • rangeStart: Date
      • rangeEnd: Date
      • Optional validateSession: boolean = true

      Returns Promise<Lesson[]>

    getOwnTimetableForToday

    getOwnTimetableForToday

    getOwnTimetableForWeek

    getOwnTimetableForWeek

    • getOwnTimetableForWeek(date, formatId?, validateSession?): Promise<WebAPITimetable[]>

    • Get the timetable for the current week for the current element from the web client API.

      Parameters

      • date: Date

        one date in the week to query

      • Optional formatId: number = 1

        set to 1 to include teachers, 2 omits the teachers in elements response

        -
      • Optional validateSession: boolean = true

      Returns Promise<WebAPITimetable[]>

    getPdfOfAbsentLesson

    • getPdfOfAbsentLesson(rangeStart, rangeEnd, validateSession?, excuseStatusId?, lateness?, absences?, excuseGroup?): Promise<string>

    • Returns a URL to a unique PDF of all the lessons you were absent

      -

      Parameters

      • rangeStart: Date
      • rangeEnd: Date
      • Optional validateSession: boolean = true
      • Optional excuseStatusId: number = -1
      • Optional lateness: boolean = true
      • Optional absences: boolean = true
      • Optional excuseGroup: number = 2

      Returns Promise<string>

    getRooms

    getSchoolyears

    getStatusData

    getStudents

    getSubjects

    getTeachers

    getTimegrid

    getTimetableFor

    getTimetableForRange

    • getTimetableForRange(rangeStart, rangeEnd, id, type, validateSession?): Promise<Lesson[]>

    • Get the timetable for a given Date range for specific element

      -

      Parameters

      • rangeStart: Date
      • rangeEnd: Date
      • id: number
      • type: number
      • Optional validateSession: boolean = true

      Returns Promise<Lesson[]>

    getTimetableForToday

    getTimetableForWeek

    • getTimetableForWeek(date, id, type, formatId?, validateSession?): Promise<WebAPITimetable[]>

    • Get the timetable for the current week for a specific element from the web client API.

      +
    • Optional validateSession: boolean = true

    Returns Promise<WebAPITimetable[]>

    getPdfOfAbsentLesson

    getRooms

    getSchoolyears

    getStatusData

    getStudents

    getSubjects

    getTeachers

    getTimegrid

    getTimetableFor

    getTimetableForRange

    getTimetableForToday

    getTimetableForWeek

    login

    Returns Promise<WebAPITimetable[]>

    login

    logout

    validateSession

    Static convertDateToUntis

    Static convertUntisDate

    logout

    validateSession

    Static convertDateToUntis

    Static convertUntisDate

    Static convertUntisTime

    Returns Date

    Static

    Static convertUntisTime

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Returns Date

    Static

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/classes/WebUntisQR.html b/docs/classes/WebUntisQR.html index 48cab97..c22c173 100644 --- a/docs/classes/WebUntisQR.html +++ b/docs/classes/WebUntisQR.html @@ -1,4 +1,4 @@ -WebUntisQR | webuntis

    Class WebUntisQR

    Hierarchy (view full)

    Constructors

    constructor +WebUntisQR | webuntis

    Class WebUntisQR

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    anonymous axios baseurl @@ -58,65 +58,65 @@
  • authenticator: Authenticator<AuthenticatorOptions<string>>

    Custom otplib v12 instance. Default will use the default otplib configuration.

  • Optional URL: typeof URL

    Custom whatwg url implementation. Default will use the nodejs implementation.

  • Optional disableUserAgent: boolean = false

    If this is true, axios will not send a custom User-Agent

    -

    • Returns WebUntisQR

    Properties

    anonymous

    anonymous: boolean

    axios

    axios: AxiosInstance

    baseurl

    baseurl: string

    cookies

    cookies: string[]

    id

    id: string

    password

    password: string

    school

    school: string

    schoolbase64

    schoolbase64: string

    sessionInformation

    sessionInformation: null | SessionInformation

    username

    username: string

    Static TYPES

    TYPES: typeof WebUntisElementType = WebUntisElementType

    Methods

    Private _buildCookies

    Private _getCookieFromSetCookie

    • _getCookieFromSetCookie(setCookieArray?, cookieName?): undefined | string
    • Private

      Parameters

      • Optional setCookieArray: string[]
      • Optional cookieName: string = 'JSESSIONID'

      Returns undefined | string

    Private _getJWT

    • _getJWT(validateSession?): Promise<string>
    • Private

      Get JWT Token

      -

      Parameters

      • validateSession: boolean = true

      Returns Promise<string>

    _otpLogin

    • _otpLogin(token, username, time, skipSessionInfo?): Promise<SessionInformation>

    • Parameters

      • token: string | number
      • username: string
      • time: number
      • skipSessionInfo: boolean = false

      Returns Promise<SessionInformation>

    Private _request

    • _request<Response>(method, parameter?, validateSession?, url?): Promise<Response>
    • Private

      Make a JSON RPC Request with the current session

      +

    Returns WebUntisQR

    Properties

    anonymous

    anonymous: boolean

    axios

    axios: AxiosInstance

    baseurl

    baseurl: string

    cookies

    cookies: string[]

    id

    id: string

    password

    password: string

    school

    school: string

    schoolbase64

    schoolbase64: string

    sessionInformation

    sessionInformation: null | SessionInformation

    username

    username: string

    Static TYPES

    TYPES: typeof WebUntisElementType = WebUntisElementType

    Methods

    Private _buildCookies

    Private _getCookieFromSetCookie

    • _getCookieFromSetCookie(setCookieArray?, cookieName?): undefined | string
    • Private

      Parameters

      • Optional setCookieArray: string[]
      • Optional cookieName: string = 'JSESSIONID'

      Returns undefined | string

    Private _getJWT

    • _getJWT(validateSession?): Promise<string>
    • Private

      Get JWT Token

      +

      Parameters

      • validateSession: boolean = true

      Returns Promise<string>

    _otpLogin

    • _otpLogin(token, username, time, skipSessionInfo?): Promise<SessionInformation>

    • Parameters

      • token: string | number
      • username: string
      • time: number
      • skipSessionInfo: boolean = false

      Returns Promise<SessionInformation>

    Private _request

    • _request<Response>(method, parameter?, validateSession?, url?): Promise<Response>
    • Private

      Make a JSON RPC Request with the current session

      Type Parameters

      • Response = Record<string, any>

      Parameters

      • method: string
      • Optional parameter: Record<string, any> = {}
      • Optional validateSession: boolean = true

        Whether the session should be checked first

        -
      • Optional url: string = ...

      Returns Promise<Response>

    getAbsentLesson

    • getAbsentLesson(rangeStart, rangeEnd, excuseStatusId?, validateSession?): Promise<Absences>

    • Returns all the Lessons where you were absent including the excused one!

      -

      Parameters

      • rangeStart: Date
      • rangeEnd: Date
      • Optional excuseStatusId: number = -1
      • Optional validateSession: boolean = true

      Returns Promise<Absences>

    getClasses

    • getClasses(validateSession?, schoolyearId): Promise<Klasse[]>

    • Get all classes known by WebUntis

      -

      Parameters

      • Optional validateSession: boolean = true
      • schoolyearId: number

      Returns Promise<Klasse[]>

    getCurrentSchoolyear

    getDepartments

    getExamsForRange

    • getExamsForRange(rangeStart, rangeEnd, klasseId?, withGrades?, validateSession?): Promise<Exam[]>

    • Get Exams for range

      -

      Parameters

      • rangeStart: Date
      • rangeEnd: Date
      • klasseId: number = -1
      • withGrades: boolean = false
      • Optional validateSession: boolean = true

      Returns Promise<Exam[]>

    getHolidays

    getHomeWorkAndLessons

    • getHomeWorkAndLessons(rangeStart, rangeEnd, validateSession?): Promise<any[]>

    • TODO: Find out what type this function returns

      -

      Parameters

      • rangeStart: Date
      • rangeEnd: Date
      • Optional validateSession: boolean = true

      Returns Promise<any[]>

    getHomeWorksFor

    getInbox

    getLatestImportTime

    • getLatestImportTime(validateSession?): Promise<number>

    • Get the time when WebUntis last changed its data

      -

      Parameters

      • Optional validateSession: boolean = true

      Returns Promise<number>

    getLatestSchoolyear

    getNewsWidget

    • getNewsWidget(date, validateSession?): Promise<NewsWidget>

    • Get News Widget

      +
    • Optional url: string = ...

    Returns Promise<Response>

    getAbsentLesson

    • getAbsentLesson(rangeStart, rangeEnd, excuseStatusId?, validateSession?): Promise<Absences>

    • Returns all the Lessons where you were absent including the excused one!

      +

      Parameters

      • rangeStart: Date
      • rangeEnd: Date
      • Optional excuseStatusId: number = -1
      • Optional validateSession: boolean = true

      Returns Promise<Absences>

    getClasses

    • getClasses(validateSession?, schoolyearId): Promise<Klasse[]>

    • Get all classes known by WebUntis

      +

      Parameters

      • Optional validateSession: boolean = true
      • schoolyearId: number

      Returns Promise<Klasse[]>

    getCurrentSchoolyear

    getDepartments

    getExamsForRange

    • getExamsForRange(rangeStart, rangeEnd, klasseId?, withGrades?, validateSession?): Promise<Exam[]>

    • Get Exams for range

      +

      Parameters

      • rangeStart: Date
      • rangeEnd: Date
      • klasseId: number = -1
      • withGrades: boolean = false
      • Optional validateSession: boolean = true

      Returns Promise<Exam[]>

    getHolidays

    getHomeWorkAndLessons

    • getHomeWorkAndLessons(rangeStart, rangeEnd, validateSession?): Promise<any[]>

    • TODO: Find out what type this function returns

      +

      Parameters

      • rangeStart: Date
      • rangeEnd: Date
      • Optional validateSession: boolean = true

      Returns Promise<any[]>

    getHomeWorksFor

    getInbox

    getLatestImportTime

    • getLatestImportTime(validateSession?): Promise<number>

    • Get the time when WebUntis last changed its data

      +

      Parameters

      • Optional validateSession: boolean = true

      Returns Promise<number>

    getLatestSchoolyear

    getNewsWidget

    getOwnClassTimetableFor

    getOwnClassTimetableFor

    • getOwnClassTimetableFor(date, validateSession?): Promise<Lesson[]>

    • Get the Timetable of your class for the given day Note: You can't use this with anonymous login

      -

      Parameters

      • date: Date
      • Optional validateSession: boolean = true

      Returns Promise<Lesson[]>

    getOwnClassTimetableForRange

    getOwnClassTimetableForRange

    • getOwnClassTimetableForRange(rangeStart, rangeEnd, validateSession?): Promise<Lesson[]>

    • Get the Timetable of your class for a given Date range Note: You can't use this with anonymous login

      -

      Parameters

      • rangeStart: Date
      • rangeEnd: Date
      • Optional validateSession: boolean = true

      Returns Promise<Lesson[]>

    getOwnClassTimetableForToday

    getOwnClassTimetableForToday

    getOwnTimetableFor

    getOwnTimetableFor

    • getOwnTimetableFor(date, validateSession?): Promise<Lesson[]>

    • Get your own Timetable for the given day Note: You can't use this with anonymous login

      -

      Parameters

      • date: Date
      • Optional validateSession: boolean = true

      Returns Promise<Lesson[]>

    getOwnTimetableForRange

    getOwnTimetableForRange

    • getOwnTimetableForRange(rangeStart, rangeEnd, validateSession?): Promise<Lesson[]>

    • Get your own timetable for a given Date range Note: You can't use this with anonymous login

      -

      Parameters

      • rangeStart: Date
      • rangeEnd: Date
      • Optional validateSession: boolean = true

      Returns Promise<Lesson[]>

    getOwnTimetableForToday

    getOwnTimetableForToday

    getOwnTimetableForWeek

    getOwnTimetableForWeek

    • getOwnTimetableForWeek(date, formatId?, validateSession?): Promise<WebAPITimetable[]>

    • Get the timetable for the current week for the current element from the web client API.

      Parameters

      • date: Date

        one date in the week to query

      • Optional formatId: number = 1

        set to 1 to include teachers, 2 omits the teachers in elements response

        -
      • Optional validateSession: boolean = true

      Returns Promise<WebAPITimetable[]>

    getPdfOfAbsentLesson

    • getPdfOfAbsentLesson(rangeStart, rangeEnd, validateSession?, excuseStatusId?, lateness?, absences?, excuseGroup?): Promise<string>

    • Returns a URL to a unique PDF of all the lessons you were absent

      -

      Parameters

      • rangeStart: Date
      • rangeEnd: Date
      • Optional validateSession: boolean = true
      • Optional excuseStatusId: number = -1
      • Optional lateness: boolean = true
      • Optional absences: boolean = true
      • Optional excuseGroup: number = 2

      Returns Promise<string>

    getRooms

    getSchoolyears

    getStatusData

    getStudents

    getSubjects

    getTeachers

    getTimegrid

    getTimetableFor

    • getTimetableFor(date, id, type, validateSession?): Promise<Lesson[]>

    • Get the timetable for a specific day for a specific element.

      -

      Parameters

      • date: Date
      • id: number
      • type: number
      • Optional validateSession: boolean = true

      Returns Promise<Lesson[]>

    getTimetableForRange

    • getTimetableForRange(rangeStart, rangeEnd, id, type, validateSession?): Promise<Lesson[]>

    • Get the timetable for a given Date range for specific element

      -

      Parameters

      • rangeStart: Date
      • rangeEnd: Date
      • id: number
      • type: number
      • Optional validateSession: boolean = true

      Returns Promise<Lesson[]>

    getTimetableForToday

    getTimetableForWeek

    • getTimetableForWeek(date, id, type, formatId?, validateSession?): Promise<WebAPITimetable[]>

    • Get the timetable for the current week for a specific element from the web client API.

      +
    • Optional validateSession: boolean = true

    Returns Promise<WebAPITimetable[]>

    getPdfOfAbsentLesson

    getRooms

    getSchoolyears

    getStatusData

    getStudents

    getSubjects

    getTeachers

    getTimegrid

    getTimetableFor

    getTimetableForRange

    getTimetableForToday

    getTimetableForWeek

    login

    Returns Promise<WebAPITimetable[]>

    login

    logout

    validateSession

    Static convertDateToUntis

    Static convertUntisDate

    logout

    validateSession

    Static convertDateToUntis

    Static convertUntisDate

    Static convertUntisTime

    Returns Date

    Static

    Static convertUntisTime

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Returns Date

    Static

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/classes/WebUntisSecretAuth.html b/docs/classes/WebUntisSecretAuth.html index 673ffeb..c210fff 100644 --- a/docs/classes/WebUntisSecretAuth.html +++ b/docs/classes/WebUntisSecretAuth.html @@ -1,4 +1,4 @@ -WebUntisSecretAuth | webuntis

    Class WebUntisSecretAuth

    Hierarchy (view full)

    Constructors

    constructor +WebUntisSecretAuth | webuntis

    Class WebUntisSecretAuth

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    anonymous authenticator axios @@ -59,65 +59,65 @@
  • Optional identity: string = 'Awesome'

    A identity like: MyAwesomeApp

  • authenticator: Authenticator<AuthenticatorOptions<string>>

    Custom otplib v12 instance. Default will use the default otplib configuration.

  • Optional disableUserAgent: boolean = false

    If this is true, axios will not send a custom User-Agent

    -

    • Returns WebUntisSecretAuth

    Properties

    anonymous

    anonymous: boolean

    Private authenticator

    authenticator: Authenticator<AuthenticatorOptions<string>>

    axios

    axios: AxiosInstance

    baseurl

    baseurl: string

    cookies

    cookies: string[]

    id

    id: string

    password

    password: string

    school

    school: string

    schoolbase64

    schoolbase64: string

    Private Readonly secret

    secret: string

    sessionInformation

    sessionInformation: null | SessionInformation

    username

    username: string

    Static TYPES

    TYPES: typeof WebUntisElementType = WebUntisElementType

    Methods

    Private _buildCookies

    Private _getCookieFromSetCookie

    Private _getJWT

    _otpLogin

    • _otpLogin(token, username, time, skipSessionInfo?): Promise<SessionInformation>

    • Parameters

      • token: string | number
      • username: string
      • time: number
      • skipSessionInfo: boolean = false

      Returns Promise<SessionInformation>

    Private _request

    • _request<Response>(method, parameter?, validateSession?, url?): Promise<Response>
    • Private

      Make a JSON RPC Request with the current session

      +

    Returns WebUntisSecretAuth

    Properties

    anonymous

    anonymous: boolean

    Private authenticator

    authenticator: Authenticator<AuthenticatorOptions<string>>

    axios

    axios: AxiosInstance

    baseurl

    baseurl: string

    cookies

    cookies: string[]

    id

    id: string

    password

    password: string

    school

    school: string

    schoolbase64

    schoolbase64: string

    Private Readonly secret

    secret: string

    sessionInformation

    sessionInformation: null | SessionInformation

    username

    username: string

    Static TYPES

    TYPES: typeof WebUntisElementType = WebUntisElementType

    Methods

    Private _buildCookies

    Private _getCookieFromSetCookie

    Private _getJWT

    _otpLogin

    • _otpLogin(token, username, time, skipSessionInfo?): Promise<SessionInformation>

    • Parameters

      • token: string | number
      • username: string
      • time: number
      • skipSessionInfo: boolean = false

      Returns Promise<SessionInformation>

    Private _request

    • _request<Response>(method, parameter?, validateSession?, url?): Promise<Response>
    • Private

      Make a JSON RPC Request with the current session

      Type Parameters

      • Response = Record<string, any>

      Parameters

      • method: string
      • Optional parameter: Record<string, any> = {}
      • Optional validateSession: boolean = true

        Whether the session should be checked first

        -
      • Optional url: string = ...

      Returns Promise<Response>

    getAbsentLesson

    • getAbsentLesson(rangeStart, rangeEnd, excuseStatusId?, validateSession?): Promise<Absences>

    • Returns all the Lessons where you were absent including the excused one!

      -

      Parameters

      • rangeStart: Date
      • rangeEnd: Date
      • Optional excuseStatusId: number = -1
      • Optional validateSession: boolean = true

      Returns Promise<Absences>

    getClasses

    getCurrentSchoolyear

    getDepartments

    getExamsForRange

    • getExamsForRange(rangeStart, rangeEnd, klasseId?, withGrades?, validateSession?): Promise<Exam[]>

    • Get Exams for range

      -

      Parameters

      • rangeStart: Date
      • rangeEnd: Date
      • klasseId: number = -1
      • withGrades: boolean = false
      • Optional validateSession: boolean = true

      Returns Promise<Exam[]>

    getHolidays

    getHomeWorkAndLessons

    • getHomeWorkAndLessons(rangeStart, rangeEnd, validateSession?): Promise<any[]>

    • TODO: Find out what type this function returns

      -

      Parameters

      • rangeStart: Date
      • rangeEnd: Date
      • Optional validateSession: boolean = true

      Returns Promise<any[]>

    getHomeWorksFor

    getInbox

    getLatestImportTime

    getLatestSchoolyear

    getNewsWidget

    • getNewsWidget(date, validateSession?): Promise<NewsWidget>

    • Get News Widget

      +
    • Optional url: string = ...

    Returns Promise<Response>

    getAbsentLesson

    • getAbsentLesson(rangeStart, rangeEnd, excuseStatusId?, validateSession?): Promise<Absences>

    • Returns all the Lessons where you were absent including the excused one!

      +

      Parameters

      • rangeStart: Date
      • rangeEnd: Date
      • Optional excuseStatusId: number = -1
      • Optional validateSession: boolean = true

      Returns Promise<Absences>

    getClasses

    getCurrentSchoolyear

    getDepartments

    getExamsForRange

    • getExamsForRange(rangeStart, rangeEnd, klasseId?, withGrades?, validateSession?): Promise<Exam[]>

    • Get Exams for range

      +

      Parameters

      • rangeStart: Date
      • rangeEnd: Date
      • klasseId: number = -1
      • withGrades: boolean = false
      • Optional validateSession: boolean = true

      Returns Promise<Exam[]>

    getHolidays

    getHomeWorkAndLessons

    • getHomeWorkAndLessons(rangeStart, rangeEnd, validateSession?): Promise<any[]>

    • TODO: Find out what type this function returns

      +

      Parameters

      • rangeStart: Date
      • rangeEnd: Date
      • Optional validateSession: boolean = true

      Returns Promise<any[]>

    getHomeWorksFor

    getInbox

    getLatestImportTime

    getLatestSchoolyear

    getNewsWidget

    getOwnClassTimetableFor

    getOwnClassTimetableFor

    getOwnClassTimetableForRange

    getOwnClassTimetableForRange

    getOwnClassTimetableForToday

    getOwnClassTimetableForToday

    getOwnTimetableFor

    getOwnTimetableFor

    getOwnTimetableForRange

    getOwnTimetableForRange

    • getOwnTimetableForRange(rangeStart, rangeEnd, validateSession?): Promise<Lesson[]>

    • Get your own timetable for a given Date range Note: You can't use this with anonymous login

      -

      Parameters

      • rangeStart: Date
      • rangeEnd: Date
      • Optional validateSession: boolean = true

      Returns Promise<Lesson[]>

    getOwnTimetableForToday

    getOwnTimetableForToday

    getOwnTimetableForWeek

    getOwnTimetableForWeek

    • getOwnTimetableForWeek(date, formatId?, validateSession?): Promise<WebAPITimetable[]>

    • Get the timetable for the current week for the current element from the web client API.

      Parameters

      • date: Date

        one date in the week to query

      • Optional formatId: number = 1

        set to 1 to include teachers, 2 omits the teachers in elements response

        -
      • Optional validateSession: boolean = true

      Returns Promise<WebAPITimetable[]>

    getPdfOfAbsentLesson

    • getPdfOfAbsentLesson(rangeStart, rangeEnd, validateSession?, excuseStatusId?, lateness?, absences?, excuseGroup?): Promise<string>

    • Returns a URL to a unique PDF of all the lessons you were absent

      -

      Parameters

      • rangeStart: Date
      • rangeEnd: Date
      • Optional validateSession: boolean = true
      • Optional excuseStatusId: number = -1
      • Optional lateness: boolean = true
      • Optional absences: boolean = true
      • Optional excuseGroup: number = 2

      Returns Promise<string>

    getRooms

    getSchoolyears

    getStatusData

    getStudents

    getSubjects

    getTeachers

    getTimegrid

    getTimetableFor

    getTimetableForRange

    • getTimetableForRange(rangeStart, rangeEnd, id, type, validateSession?): Promise<Lesson[]>

    • Get the timetable for a given Date range for specific element

      -

      Parameters

      • rangeStart: Date
      • rangeEnd: Date
      • id: number
      • type: number
      • Optional validateSession: boolean = true

      Returns Promise<Lesson[]>

    getTimetableForToday

    getTimetableForWeek

    • getTimetableForWeek(date, id, type, formatId?, validateSession?): Promise<WebAPITimetable[]>

    • Get the timetable for the current week for a specific element from the web client API.

      +
    • Optional validateSession: boolean = true

    Returns Promise<WebAPITimetable[]>

    getPdfOfAbsentLesson

    getRooms

    getSchoolyears

    getStatusData

    getStudents

    getSubjects

    getTeachers

    getTimegrid

    getTimetableFor

    getTimetableForRange

    getTimetableForToday

    getTimetableForWeek

    login

    Returns Promise<WebAPITimetable[]>

    login

    logout

    validateSession

    Static convertDateToUntis

    Static convertUntisDate

    logout

    validateSession

    Static convertDateToUntis

    Static convertUntisDate

    Static convertUntisTime

    Returns Date

    Static

    Static convertUntisTime

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Returns Date

    Static

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/enums/WebUntisDay.html b/docs/enums/WebUntisDay.html index d4fb611..c597182 100644 --- a/docs/enums/WebUntisDay.html +++ b/docs/enums/WebUntisDay.html @@ -1,8 +1,8 @@ -WebUntisDay | webuntis

    Enumeration WebUntisDay

    Enumeration Members

    Friday +WebUntisDay | webuntis

    Enumeration WebUntisDay

    Enumeration Members

    Friday Monday Saturday Sunday Thursday Tuesday Wednesday -

    Enumeration Members

    Friday

    Friday: 6

    Monday

    Monday: 2

    Saturday

    Saturday: 7

    Sunday

    Sunday: 1

    Thursday

    Thursday: 5

    Tuesday

    Tuesday: 3

    Wednesday

    Wednesday: 4

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Enumeration Members

    Friday

    Friday: 6

    Monday

    Monday: 2

    Saturday

    Saturday: 7

    Sunday

    Sunday: 1

    Thursday

    Thursday: 5

    Tuesday

    Tuesday: 3

    Wednesday

    Wednesday: 4

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/enums/WebUntisElementType.html b/docs/enums/WebUntisElementType.html index 4c7b859..4386e01 100644 --- a/docs/enums/WebUntisElementType.html +++ b/docs/enums/WebUntisElementType.html @@ -1,6 +1,6 @@ -WebUntisElementType | webuntis

    Enumeration WebUntisElementType

    Enumeration Members

    CLASS +WebUntisElementType | webuntis

    Enumeration WebUntisElementType

    Enumeration Members

    CLASS ROOM STUDENT SUBJECT TEACHER -

    Enumeration Members

    CLASS

    CLASS: 1

    ROOM

    ROOM: 4

    STUDENT

    STUDENT: 5

    SUBJECT

    SUBJECT: 3

    TEACHER

    TEACHER: 2

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Enumeration Members

    CLASS

    CLASS: 1

    ROOM

    ROOM: 4

    STUDENT

    STUDENT: 5

    SUBJECT

    SUBJECT: 3

    TEACHER

    TEACHER: 2

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/Absence.html b/docs/interfaces/Absence.html index 5a8c5fc..20bfd49 100644 --- a/docs/interfaces/Absence.html +++ b/docs/interfaces/Absence.html @@ -1,4 +1,4 @@ -Absence | webuntis

    Interface Absence

    interface Absence {
        canEdit: boolean;
        createDate: number;
        createdUser: string;
        endDate: number;
        endTime: number;
        excuse: Excuse;
        excuseStatus: string;
        id: number;
        interruptions: [];
        isExcused: boolean;
        lastUpdate: number;
        reason: string;
        reasonId: number;
        startDate: number;
        startTime: number;
        studentName: string;
        text: string;
        updatedUser: string;
    }

    Properties

    canEdit +Absence | webuntis

    Interface Absence

    interface Absence {
        canEdit: boolean;
        createDate: number;
        createdUser: string;
        endDate: number;
        endTime: number;
        excuse: Excuse;
        excuseStatus: string;
        id: number;
        interruptions: [];
        isExcused: boolean;
        lastUpdate: number;
        reason: string;
        reasonId: number;
        startDate: number;
        startTime: number;
        studentName: string;
        text: string;
        updatedUser: string;
    }

    Properties

    canEdit createDate createdUser endDate @@ -16,4 +16,4 @@ studentName text updatedUser -

    Properties

    canEdit

    canEdit: boolean

    createDate

    createDate: number

    createdUser

    createdUser: string

    endDate

    endDate: number

    endTime

    endTime: number

    excuse

    excuse: Excuse

    excuseStatus

    excuseStatus: string

    id

    id: number

    interruptions

    interruptions: []

    isExcused

    isExcused: boolean

    lastUpdate

    lastUpdate: number

    reason

    reason: string

    reasonId

    reasonId: number

    startDate

    startDate: number

    startTime

    startTime: number

    studentName

    studentName: string

    text

    text: string

    updatedUser

    updatedUser: string

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Properties

    canEdit

    canEdit: boolean

    createDate

    createDate: number

    createdUser

    createdUser: string

    endDate

    endDate: number

    endTime

    endTime: number

    excuse

    excuse: Excuse

    excuseStatus

    excuseStatus: string

    id

    id: number

    interruptions

    interruptions: []

    isExcused

    isExcused: boolean

    lastUpdate

    lastUpdate: number

    reason

    reason: string

    reasonId

    reasonId: number

    startDate

    startDate: number

    startTime

    startTime: number

    studentName

    studentName: string

    text

    text: string

    updatedUser

    updatedUser: string

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/Absences.html b/docs/interfaces/Absences.html index d977fc7..5f14cd8 100644 --- a/docs/interfaces/Absences.html +++ b/docs/interfaces/Absences.html @@ -1,6 +1,6 @@ -Absences | webuntis

    Interface Absences

    interface Absences {
        absenceReasons: [];
        absences: Absence[];
        excuseStatuses: boolean;
        showAbsenceReasonChange: boolean;
        showCreateAbsence: boolean;
    }

    Properties

    absenceReasons +Absences | webuntis

    Interface Absences

    interface Absences {
        absenceReasons: [];
        absences: Absence[];
        excuseStatuses: boolean;
        showAbsenceReasonChange: boolean;
        showCreateAbsence: boolean;
    }

    Properties

    absenceReasons absences excuseStatuses showAbsenceReasonChange showCreateAbsence -

    Properties

    absenceReasons

    absenceReasons: []

    absences

    absences: Absence[]

    excuseStatuses

    excuseStatuses: boolean

    showAbsenceReasonChange

    showAbsenceReasonChange: boolean

    showCreateAbsence

    showCreateAbsence: boolean

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Properties

    absenceReasons

    absenceReasons: []

    absences

    absences: Absence[]

    excuseStatuses

    excuseStatuses: boolean

    showAbsenceReasonChange

    showAbsenceReasonChange: boolean

    showCreateAbsence

    showCreateAbsence: boolean

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/CodesEntity.html b/docs/interfaces/CodesEntity.html index 82f1732..a88c641 100644 --- a/docs/interfaces/CodesEntity.html +++ b/docs/interfaces/CodesEntity.html @@ -1,3 +1,3 @@ -CodesEntity | webuntis

    Interface CodesEntity

    interface CodesEntity {
        cancelled?: null | ColorEntity;
        irregular?: null | ColorEntity;
    }

    Properties

    cancelled? +CodesEntity | webuntis

    Interface CodesEntity

    interface CodesEntity {
        cancelled?: null | ColorEntity;
        irregular?: null | ColorEntity;
    }

    Properties

    cancelled? irregular? -

    Properties

    Optional cancelled

    cancelled?: null | ColorEntity

    Optional irregular

    irregular?: null | ColorEntity

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Properties

    Optional cancelled

    cancelled?: null | ColorEntity

    Optional irregular

    irregular?: null | ColorEntity

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/ColorEntity.html b/docs/interfaces/ColorEntity.html index ead98bf..2650e43 100644 --- a/docs/interfaces/ColorEntity.html +++ b/docs/interfaces/ColorEntity.html @@ -1,3 +1,3 @@ -ColorEntity | webuntis

    Interface ColorEntity

    interface ColorEntity {
        backColor: string;
        foreColor: string;
    }

    Properties

    backColor +ColorEntity | webuntis

    Interface ColorEntity

    interface ColorEntity {
        backColor: string;
        foreColor: string;
    }

    Properties

    backColor foreColor -

    Properties

    backColor

    backColor: string

    foreColor

    foreColor: string

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Properties

    backColor

    backColor: string

    foreColor

    foreColor: string

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/Department.html b/docs/interfaces/Department.html index 7bad410..1d1c371 100644 --- a/docs/interfaces/Department.html +++ b/docs/interfaces/Department.html @@ -1,4 +1,4 @@ -Department | webuntis

    Interface Department

    interface Department {
        id: number;
        longName: string;
        name: string;
    }

    Properties

    id +Department | webuntis

    Interface Department

    interface Department {
        id: number;
        longName: string;
        name: string;
    }

    Properties

    id longName name -

    Properties

    id

    id: number

    longName

    longName: string

    name

    name: string

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Properties

    id

    id: number

    longName

    longName: string

    name

    name: string

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/Exam.html b/docs/interfaces/Exam.html index 29004d1..b14ada9 100644 --- a/docs/interfaces/Exam.html +++ b/docs/interfaces/Exam.html @@ -1,4 +1,4 @@ -Exam | webuntis

    Interface Exam

    interface Exam {
        assignedStudents: {
            displayName: string;
            id: number;
            klasse: {
                id: number;
                name: string;
            };
        }[];
        endTime: number;
        examDate: number;
        examType: string;
        grade?: string;
        id: number;
        name: string;
        rooms: string[];
        startTime: number;
        studentClass: string[];
        subject: string;
        teachers: string[];
        text: string;
    }

    Properties

    assignedStudents +Exam | webuntis

    Interface Exam

    interface Exam {
        assignedStudents: {
            displayName: string;
            id: number;
            klasse: {
                id: number;
                name: string;
            };
        }[];
        endTime: number;
        examDate: number;
        examType: string;
        grade?: string;
        id: number;
        name: string;
        rooms: string[];
        startTime: number;
        studentClass: string[];
        subject: string;
        teachers: string[];
        text: string;
    }

    Properties

    assignedStudents endTime examDate examType @@ -11,4 +11,4 @@ subject teachers text -

    Properties

    assignedStudents

    assignedStudents: {
        displayName: string;
        id: number;
        klasse: {
            id: number;
            name: string;
        };
    }[]

    Type declaration

    • displayName: string
    • id: number
    • klasse: {
          id: number;
          name: string;
      }
      • id: number
      • name: string

    endTime

    endTime: number

    examDate

    examDate: number

    examType

    examType: string

    Optional grade

    grade?: string

    id

    id: number

    name

    name: string

    rooms

    rooms: string[]

    startTime

    startTime: number

    studentClass

    studentClass: string[]

    subject

    subject: string

    teachers

    teachers: string[]

    text

    text: string

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Properties

    assignedStudents

    assignedStudents: {
        displayName: string;
        id: number;
        klasse: {
            id: number;
            name: string;
        };
    }[]

    Type declaration

    • displayName: string
    • id: number
    • klasse: {
          id: number;
          name: string;
      }
      • id: number
      • name: string

    endTime

    endTime: number

    examDate

    examDate: number

    examType

    examType: string

    Optional grade

    grade?: string

    id

    id: number

    name

    name: string

    rooms

    rooms: string[]

    startTime

    startTime: number

    studentClass

    studentClass: string[]

    subject

    subject: string

    teachers

    teachers: string[]

    text

    text: string

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/Excuse.html b/docs/interfaces/Excuse.html index 74b1305..12c76bc 100644 --- a/docs/interfaces/Excuse.html +++ b/docs/interfaces/Excuse.html @@ -1,8 +1,8 @@ -Excuse | webuntis

    Interface Excuse

    interface Excuse {
        excuseDate: number;
        excuseStatus: string;
        id: number;
        isExcused: boolean;
        text: string;
        userId: number;
        username: string;
    }

    Properties

    excuseDate +Excuse | webuntis

    Interface Excuse

    interface Excuse {
        excuseDate: number;
        excuseStatus: string;
        id: number;
        isExcused: boolean;
        text: string;
        userId: number;
        username: string;
    }

    Properties

    excuseDate excuseStatus id isExcused text userId username -

    Properties

    excuseDate

    excuseDate: number

    excuseStatus

    excuseStatus: string

    id

    id: number

    isExcused

    isExcused: boolean

    text

    text: string

    userId

    userId: number

    username

    username: string

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Properties

    excuseDate

    excuseDate: number

    excuseStatus

    excuseStatus: string

    id

    id: number

    isExcused

    isExcused: boolean

    text

    text: string

    userId

    userId: number

    username

    username: string

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/Holiday.html b/docs/interfaces/Holiday.html index 753ffac..2184e86 100644 --- a/docs/interfaces/Holiday.html +++ b/docs/interfaces/Holiday.html @@ -1,6 +1,6 @@ -Holiday | webuntis

    Interface Holiday

    interface Holiday {
        endDate: number;
        id: number;
        longName: string;
        name: string;
        startDate: number;
    }

    Properties

    endDate +Holiday | webuntis

    Interface Holiday

    interface Holiday {
        endDate: number;
        id: number;
        longName: string;
        name: string;
        startDate: number;
    }

    Properties

    endDate id longName name startDate -

    Properties

    endDate

    endDate: number

    id

    id: number

    longName

    longName: string

    name

    name: string

    startDate

    startDate: number

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Properties

    endDate

    endDate: number

    id

    id: number

    longName

    longName: string

    name

    name: string

    startDate

    startDate: number

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/Homework.html b/docs/interfaces/Homework.html index a018314..0cc3ae2 100644 --- a/docs/interfaces/Homework.html +++ b/docs/interfaces/Homework.html @@ -1,4 +1,4 @@ -Homework | webuntis

    Interface Homework

    interface Homework {
        attachments: any[];
        completed: boolean;
        date: number;
        dueDate: number;
        id: number;
        lessonId: number;
        remark: string;
        text: string;
    }

    Properties

    attachments +Homework | webuntis

    Interface Homework

    interface Homework {
        attachments: any[];
        completed: boolean;
        date: number;
        dueDate: number;
        id: number;
        lessonId: number;
        remark: string;
        text: string;
    }

    Properties

    attachments completed date dueDate @@ -7,4 +7,4 @@ remark text

    Properties

    attachments

    attachments: any[]

    Unknown type. I have never seen this in use.

    -

    completed

    completed: boolean

    date

    date: number

    dueDate

    dueDate: number

    id

    id: number

    lessonId

    lessonId: number

    remark

    remark: string

    text

    text: string

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    completed

    completed: boolean

    date

    date: number

    dueDate

    dueDate: number

    id

    id: number

    lessonId

    lessonId: number

    remark

    remark: string

    text

    text: string

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/Inbox.html b/docs/interfaces/Inbox.html index cb72533..86d81a3 100644 --- a/docs/interfaces/Inbox.html +++ b/docs/interfaces/Inbox.html @@ -1,2 +1,2 @@ -Inbox | webuntis

    Interface Inbox

    interface Inbox {
        incomingMessages: Inboxmessage[];
    }

    Properties

    incomingMessages -

    Properties

    incomingMessages

    incomingMessages: Inboxmessage[]

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +Inbox | webuntis

    Interface Inbox

    interface Inbox {
        incomingMessages: Inboxmessage[];
    }

    Properties

    incomingMessages +

    Properties

    incomingMessages

    incomingMessages: Inboxmessage[]

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/Inboxmessage.html b/docs/interfaces/Inboxmessage.html index 2fe0da5..e40ecd6 100644 --- a/docs/interfaces/Inboxmessage.html +++ b/docs/interfaces/Inboxmessage.html @@ -1,4 +1,4 @@ -Inboxmessage | webuntis

    Interface Inboxmessage

    interface Inboxmessage {
        allowMessageDeletion: boolean;
        contentPreview: string;
        hasAttachments: boolean;
        id: number;
        isMessageRead: boolean;
        isReply: boolean;
        isReplyAllowed: boolean;
        sender: Messagesender;
        sentDateTime: string;
        subject: string;
    }

    Properties

    allowMessageDeletion +Inboxmessage | webuntis

    Interface Inboxmessage

    interface Inboxmessage {
        allowMessageDeletion: boolean;
        contentPreview: string;
        hasAttachments: boolean;
        id: number;
        isMessageRead: boolean;
        isReply: boolean;
        isReplyAllowed: boolean;
        sender: Messagesender;
        sentDateTime: string;
        subject: string;
    }

    Properties

    allowMessageDeletion contentPreview hasAttachments id @@ -8,4 +8,4 @@ sender sentDateTime subject -

    Properties

    allowMessageDeletion

    allowMessageDeletion: boolean

    contentPreview

    contentPreview: string

    hasAttachments

    hasAttachments: boolean

    id

    id: number

    isMessageRead

    isMessageRead: boolean

    isReply

    isReply: boolean

    isReplyAllowed

    isReplyAllowed: boolean

    sender

    sender: Messagesender

    sentDateTime

    sentDateTime: string

    subject

    subject: string

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Properties

    allowMessageDeletion

    allowMessageDeletion: boolean

    contentPreview

    contentPreview: string

    hasAttachments

    hasAttachments: boolean

    id

    id: number

    isMessageRead

    isMessageRead: boolean

    isReply

    isReply: boolean

    isReplyAllowed

    isReplyAllowed: boolean

    sender

    sender: Messagesender

    sentDateTime

    sentDateTime: string

    subject

    subject: string

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/Klasse.html b/docs/interfaces/Klasse.html index b482c1a..c1f8957 100644 --- a/docs/interfaces/Klasse.html +++ b/docs/interfaces/Klasse.html @@ -1,4 +1,4 @@ -Klasse | webuntis

    Interface Klasse

    interface Klasse {
        active: boolean;
        backColor?: string;
        did?: number;
        foreColor?: string;
        id: number;
        longName: string;
        name: string;
        teacher1?: number;
        teacher2?: number;
    }

    Properties

    active +Klasse | webuntis

    Interface Klasse

    interface Klasse {
        active: boolean;
        backColor?: string;
        did?: number;
        foreColor?: string;
        id: number;
        longName: string;
        name: string;
        teacher1?: number;
        teacher2?: number;
    }

    Properties

    active backColor? did? foreColor? @@ -7,4 +7,4 @@ name teacher1? teacher2? -

    Properties

    active

    active: boolean

    Optional backColor

    backColor?: string

    Optional did

    did?: number

    Optional foreColor

    foreColor?: string

    id

    id: number

    longName

    longName: string

    name

    name: string

    Optional teacher1

    teacher1?: number

    Optional teacher2

    teacher2?: number

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Properties

    active

    active: boolean

    Optional backColor

    backColor?: string

    Optional did

    did?: number

    Optional foreColor

    foreColor?: string

    id

    id: number

    longName

    longName: string

    name

    name: string

    Optional teacher1

    teacher1?: number

    Optional teacher2

    teacher2?: number

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/Lesson.html b/docs/interfaces/Lesson.html index 60fe849..a7c8d70 100644 --- a/docs/interfaces/Lesson.html +++ b/docs/interfaces/Lesson.html @@ -1,4 +1,4 @@ -Lesson | webuntis

    Interface Lesson

    interface Lesson {
        activityType?: string;
        bkRemark?: string;
        bkText?: string;
        code?: "cancelled" | "irregular";
        date: number;
        endTime: number;
        id: number;
        info?: string;
        kl: ShortData[];
        lsnumber: number;
        lstext?: string;
        ro: ShortData[];
        sg?: string;
        startTime: number;
        statflags?: string;
        su: ShortData[];
        substText?: string;
        te: ShortData[];
    }

    Properties

    activityType? +Lesson | webuntis

    Interface Lesson

    interface Lesson {
        activityType?: string;
        bkRemark?: string;
        bkText?: string;
        code?: "cancelled" | "irregular";
        date: number;
        endTime: number;
        id: number;
        info?: string;
        kl: ShortData[];
        lsnumber: number;
        lstext?: string;
        ro: ShortData[];
        sg?: string;
        startTime: number;
        statflags?: string;
        su: ShortData[];
        substText?: string;
        te: ShortData[];
    }

    Properties

    activityType? bkRemark? bkText? code? @@ -16,4 +16,4 @@ su substText? te -

    Properties

    Optional activityType

    activityType?: string

    Optional bkRemark

    bkRemark?: string

    Optional bkText

    bkText?: string

    Optional code

    code?: "cancelled" | "irregular"

    date

    date: number

    endTime

    endTime: number

    id

    id: number

    Optional info

    info?: string

    kl

    kl: ShortData[]

    lsnumber

    lsnumber: number

    Optional lstext

    lstext?: string

    ro

    ro: ShortData[]

    Optional sg

    sg?: string

    startTime

    startTime: number

    Optional statflags

    statflags?: string

    su

    su: ShortData[]

    Optional substText

    substText?: string

    te

    te: ShortData[]

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Properties

    Optional activityType

    activityType?: string

    Optional bkRemark

    bkRemark?: string

    Optional bkText

    bkText?: string

    Optional code

    code?: "cancelled" | "irregular"

    date

    date: number

    endTime

    endTime: number

    id

    id: number

    Optional info

    info?: string

    kl

    kl: ShortData[]

    lsnumber

    lsnumber: number

    Optional lstext

    lstext?: string

    ro

    ro: ShortData[]

    Optional sg

    sg?: string

    startTime

    startTime: number

    Optional statflags

    statflags?: string

    su

    su: ShortData[]

    Optional substText

    substText?: string

    te

    te: ShortData[]

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/LsEntity.html b/docs/interfaces/LsEntity.html index 63ec2bd..86e6645 100644 --- a/docs/interfaces/LsEntity.html +++ b/docs/interfaces/LsEntity.html @@ -1,6 +1,6 @@ -LsEntity | webuntis

    Interface LsEntity

    interface LsEntity {
        bs?: null | ColorEntity;
        ex?: null | ColorEntity;
        ls?: null | ColorEntity;
        oh?: null | ColorEntity;
        sb?: null | ColorEntity;
    }

    Properties

    bs? +LsEntity | webuntis

    Interface LsEntity

    interface LsEntity {
        bs?: null | ColorEntity;
        ex?: null | ColorEntity;
        ls?: null | ColorEntity;
        oh?: null | ColorEntity;
        sb?: null | ColorEntity;
    }

    Properties

    bs? ex? ls? oh? sb? -

    Properties

    Optional bs

    bs?: null | ColorEntity

    Optional ex

    ex?: null | ColorEntity

    Optional ls

    ls?: null | ColorEntity

    Optional oh

    oh?: null | ColorEntity

    Optional sb

    sb?: null | ColorEntity

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Properties

    Optional bs

    bs?: null | ColorEntity

    Optional ex

    ex?: null | ColorEntity

    Optional ls

    ls?: null | ColorEntity

    Optional oh

    oh?: null | ColorEntity

    Optional sb

    sb?: null | ColorEntity

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/MessagesOfDay.html b/docs/interfaces/MessagesOfDay.html index 9c4ef80..597eabe 100644 --- a/docs/interfaces/MessagesOfDay.html +++ b/docs/interfaces/MessagesOfDay.html @@ -1,7 +1,7 @@ -MessagesOfDay | webuntis

    Interface MessagesOfDay

    interface MessagesOfDay {
        attachments: any[];
        id: number;
        isExpanded: boolean;
        subject: string;
        text: string;
    }

    Properties

    attachments +MessagesOfDay | webuntis

    Interface MessagesOfDay

    interface MessagesOfDay {
        attachments: any[];
        id: number;
        isExpanded: boolean;
        subject: string;
        text: string;
    }

    Properties

    attachments id isExpanded subject text

    Properties

    attachments

    attachments: any[]

    Unknown type. I have never seen this in use.

    -

    id

    id: number

    isExpanded

    isExpanded: boolean

    subject

    subject: string

    text

    text: string

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    id

    id: number

    isExpanded

    isExpanded: boolean

    subject

    subject: string

    text

    text: string

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/Messagesender.html b/docs/interfaces/Messagesender.html index 44f1b8c..7342a10 100644 --- a/docs/interfaces/Messagesender.html +++ b/docs/interfaces/Messagesender.html @@ -1,5 +1,5 @@ -Messagesender | webuntis

    Interface Messagesender

    interface Messagesender {
        className: string;
        displayName: string;
        imageUrl: string;
        userId: number;
    }

    Properties

    className +Messagesender | webuntis

    Interface Messagesender

    interface Messagesender {
        className: string;
        displayName: string;
        imageUrl: string;
        userId: number;
    }

    Properties

    className displayName imageUrl userId -

    Properties

    className

    className: string

    displayName

    displayName: string

    imageUrl

    imageUrl: string

    userId

    userId: number

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Properties

    className

    className: string

    displayName

    displayName: string

    imageUrl

    imageUrl: string

    userId

    userId: number

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/NewsWidget.html b/docs/interfaces/NewsWidget.html index e57837a..eb91fbb 100644 --- a/docs/interfaces/NewsWidget.html +++ b/docs/interfaces/NewsWidget.html @@ -1,5 +1,5 @@ -NewsWidget | webuntis

    Interface NewsWidget

    interface NewsWidget {
        messagesOfDay: MessagesOfDay[];
        rssUrl: string;
        systemMessage: any;
    }

    Properties

    messagesOfDay +NewsWidget | webuntis

    Interface NewsWidget

    interface NewsWidget {
        messagesOfDay: MessagesOfDay[];
        rssUrl: string;
        systemMessage: any;
    }

    Properties

    messagesOfDay rssUrl systemMessage -

    Properties

    messagesOfDay

    messagesOfDay: MessagesOfDay[]

    rssUrl

    rssUrl: string

    systemMessage

    systemMessage: any

    Unknown type. I have never seen this in use.

    -

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Properties

    messagesOfDay

    messagesOfDay: MessagesOfDay[]

    rssUrl

    rssUrl: string

    systemMessage

    systemMessage: any

    Unknown type. I have never seen this in use.

    +

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/Room.html b/docs/interfaces/Room.html index 7067a72..93ae3d8 100644 --- a/docs/interfaces/Room.html +++ b/docs/interfaces/Room.html @@ -1,8 +1,8 @@ -Room | webuntis

    Interface Room

    interface Room {
        active: boolean;
        alternateName: string;
        backColor: string;
        foreColor: string;
        id: number;
        longName: string;
        name: string;
    }

    Properties

    active +Room | webuntis

    Interface Room

    interface Room {
        active: boolean;
        alternateName: string;
        backColor: string;
        foreColor: string;
        id: number;
        longName: string;
        name: string;
    }

    Properties

    active alternateName backColor foreColor id longName name -

    Properties

    active

    active: boolean

    alternateName

    alternateName: string

    backColor

    backColor: string

    foreColor

    foreColor: string

    id

    id: number

    longName

    longName: string

    name

    name: string

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Properties

    active

    active: boolean

    alternateName

    alternateName: string

    backColor

    backColor: string

    foreColor

    foreColor: string

    id

    id: number

    longName

    longName: string

    name

    name: string

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/SchoolYear.html b/docs/interfaces/SchoolYear.html index 890e3e2..3a32b1e 100644 --- a/docs/interfaces/SchoolYear.html +++ b/docs/interfaces/SchoolYear.html @@ -1,5 +1,5 @@ -SchoolYear | webuntis

    Interface SchoolYear

    interface SchoolYear {
        endDate: Date;
        id: number;
        name: string;
        startDate: Date;
    }

    Properties

    endDate +SchoolYear | webuntis

    Interface SchoolYear

    interface SchoolYear {
        endDate: Date;
        id: number;
        name: string;
        startDate: Date;
    }

    Properties

    endDate id name startDate -

    Properties

    endDate

    endDate: Date

    id

    id: number

    name

    name: string

    startDate

    startDate: Date

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Properties

    endDate

    endDate: Date

    id

    id: number

    name

    name: string

    startDate

    startDate: Date

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/ShortData.html b/docs/interfaces/ShortData.html index 9a0beb8..a5cb5fc 100644 --- a/docs/interfaces/ShortData.html +++ b/docs/interfaces/ShortData.html @@ -1,6 +1,6 @@ -ShortData | webuntis

    Interface ShortData

    interface ShortData {
        id: number;
        longname: string;
        name: string;
        orgid?: number;
        orgname?: string;
    }

    Properties

    id +ShortData | webuntis

    Interface ShortData

    interface ShortData {
        id: number;
        longname: string;
        name: string;
        orgid?: number;
        orgname?: string;
    }

    Properties

    id longname name orgid? orgname? -

    Properties

    id

    id: number

    longname

    longname: string

    name

    name: string

    Optional orgid

    orgid?: number

    Optional orgname

    orgname?: string

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Properties

    id

    id: number

    longname

    longname: string

    name

    name: string

    Optional orgid

    orgid?: number

    Optional orgname

    orgname?: string

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/StatusData.html b/docs/interfaces/StatusData.html index b45d563..e654de2 100644 --- a/docs/interfaces/StatusData.html +++ b/docs/interfaces/StatusData.html @@ -1,3 +1,3 @@ -StatusData | webuntis

    Interface StatusData

    interface StatusData {
        codes: CodesEntity[];
        lstypes: LsEntity[];
    }

    Properties

    codes +StatusData | webuntis

    Interface StatusData

    interface StatusData {
        codes: CodesEntity[];
        lstypes: LsEntity[];
    }

    Properties

    codes lstypes -

    Properties

    codes

    codes: CodesEntity[]

    lstypes

    lstypes: LsEntity[]

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Properties

    codes

    codes: CodesEntity[]

    lstypes

    lstypes: LsEntity[]

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/Student.html b/docs/interfaces/Student.html index 119e0c1..07e8c92 100644 --- a/docs/interfaces/Student.html +++ b/docs/interfaces/Student.html @@ -1,7 +1,7 @@ -Student | webuntis

    Interface Student

    interface Student {
        foreName: string;
        gender: string;
        id: number;
        key: number;
        longName: string;
        name: string;
    }

    Properties

    foreName +Student | webuntis

    Interface Student

    interface Student {
        foreName: string;
        gender: string;
        id: number;
        key: number;
        longName: string;
        name: string;
    }

    Properties

    foreName gender id key longName name -

    Properties

    foreName

    foreName: string

    gender

    gender: string

    id

    id: number

    key

    key: number

    longName

    longName: string

    name

    name: string

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Properties

    foreName

    foreName: string

    gender

    gender: string

    id

    id: number

    key

    key: number

    longName

    longName: string

    name

    name: string

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/Subject.html b/docs/interfaces/Subject.html index dcb39b8..c2d381f 100644 --- a/docs/interfaces/Subject.html +++ b/docs/interfaces/Subject.html @@ -1,8 +1,8 @@ -Subject | webuntis

    Interface Subject

    interface Subject {
        active: boolean;
        alternateName: string;
        backColor: string;
        foreColor: string;
        id: number;
        longName: string;
        name: string;
    }

    Properties

    active +Subject | webuntis

    Interface Subject

    interface Subject {
        active: boolean;
        alternateName: string;
        backColor: string;
        foreColor: string;
        id: number;
        longName: string;
        name: string;
    }

    Properties

    active alternateName backColor foreColor id longName name -

    Properties

    active

    active: boolean

    alternateName

    alternateName: string

    backColor

    backColor: string

    foreColor

    foreColor: string

    id

    id: number

    longName

    longName: string

    name

    name: string

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Properties

    active

    active: boolean

    alternateName

    alternateName: string

    backColor

    backColor: string

    foreColor

    foreColor: string

    id

    id: number

    longName

    longName: string

    name

    name: string

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/Teacher.html b/docs/interfaces/Teacher.html index ee56f2f..5783445 100644 --- a/docs/interfaces/Teacher.html +++ b/docs/interfaces/Teacher.html @@ -1,7 +1,7 @@ -Teacher | webuntis

    Interface Teacher

    interface Teacher {
        backColor: string;
        foreColor: string;
        foreName: string;
        id: number;
        longName: string;
        name: string;
    }

    Properties

    backColor +Teacher | webuntis

    Interface Teacher

    interface Teacher {
        backColor: string;
        foreColor: string;
        foreName: string;
        id: number;
        longName: string;
        name: string;
    }

    Properties

    backColor foreColor foreName id longName name -

    Properties

    backColor

    backColor: string

    foreColor

    foreColor: string

    foreName

    foreName: string

    id

    id: number

    longName

    longName: string

    name

    name: string

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Properties

    backColor

    backColor: string

    foreColor

    foreColor: string

    foreName

    foreName: string

    id

    id: number

    longName

    longName: string

    name

    name: string

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/TimeUnit.html b/docs/interfaces/TimeUnit.html index 56c678f..357b3f3 100644 --- a/docs/interfaces/TimeUnit.html +++ b/docs/interfaces/TimeUnit.html @@ -1,4 +1,4 @@ -TimeUnit | webuntis

    Interface TimeUnit

    interface TimeUnit {
        endTime: number;
        name: string;
        startTime: number;
    }

    Properties

    endTime +TimeUnit | webuntis

    Interface TimeUnit

    interface TimeUnit {
        endTime: number;
        name: string;
        startTime: number;
    }

    Properties

    endTime name startTime -

    Properties

    endTime

    endTime: number

    name

    name: string

    startTime

    startTime: number

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Properties

    endTime

    endTime: number

    name

    name: string

    startTime

    startTime: number

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/Timegrid.html b/docs/interfaces/Timegrid.html index 2baccb9..033b039 100644 --- a/docs/interfaces/Timegrid.html +++ b/docs/interfaces/Timegrid.html @@ -1,3 +1,3 @@ -Timegrid | webuntis

    Interface Timegrid

    interface Timegrid {
        day: WebUntisDay;
        timeUnits: TimeUnit[];
    }

    Properties

    day +Timegrid | webuntis

    Interface Timegrid

    interface Timegrid {
        day: WebUntisDay;
        timeUnits: TimeUnit[];
    }

    Properties

    day timeUnits -

    Properties

    day

    day: WebUntisDay

    timeUnits

    timeUnits: TimeUnit[]

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Properties

    day

    day: WebUntisDay

    timeUnits

    timeUnits: TimeUnit[]

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/WebAPITimetable.html b/docs/interfaces/WebAPITimetable.html index eb25c91..7a29829 100644 --- a/docs/interfaces/WebAPITimetable.html +++ b/docs/interfaces/WebAPITimetable.html @@ -1,4 +1,4 @@ -WebAPITimetable | webuntis

    Interface WebAPITimetable

    interface WebAPITimetable {
        cellState: "STANDARD" | "SUBSTITUTION" | "ROOMSUBSTITUTION";
        classes: WebElementData[];
        code: number;
        date: number;
        elements: WebElement[];
        endTime: number;
        hasInfo: boolean;
        hasPeriodText: false;
        id: number;
        is: {
            event: boolean;
            roomSubstitution?: boolean;
            standard?: boolean;
            substitution?: boolean;
        };
        lessonCode: string;
        lessonId: number;
        lessonNumber: number;
        lessonText: string;
        periodAttachments: [];
        periodInfo: string;
        periodText: string;
        priority: number;
        roomCapacity: number;
        rooms: WebElementData[];
        startTime: number;
        studentCount: number;
        studentGroup: string;
        students: WebElementData[];
        subjects: WebElementData[];
        substText: string;
        teachers: WebElementData[];
    }

    Properties

    cellState +WebAPITimetable | webuntis

    Interface WebAPITimetable

    interface WebAPITimetable {
        cellState: "STANDARD" | "SUBSTITUTION" | "ROOMSUBSTITUTION";
        classes: WebElementData[];
        code: number;
        date: number;
        elements: WebElement[];
        endTime: number;
        hasInfo: boolean;
        hasPeriodText: false;
        id: number;
        is: {
            event: boolean;
            roomSubstitution?: boolean;
            standard?: boolean;
            substitution?: boolean;
        };
        lessonCode: string;
        lessonId: number;
        lessonNumber: number;
        lessonText: string;
        periodAttachments: [];
        periodInfo: string;
        periodText: string;
        priority: number;
        roomCapacity: number;
        rooms: WebElementData[];
        startTime: number;
        studentCount: number;
        studentGroup: string;
        students: WebElementData[];
        subjects: WebElementData[];
        substText: string;
        teachers: WebElementData[];
    }

    Properties

    cellState classes code date @@ -25,4 +25,4 @@ subjects substText teachers -

    Properties

    cellState

    cellState: "STANDARD" | "SUBSTITUTION" | "ROOMSUBSTITUTION"

    classes

    classes: WebElementData[]

    code

    code: number

    date

    date: number

    elements

    elements: WebElement[]

    endTime

    endTime: number

    hasInfo

    hasInfo: boolean

    hasPeriodText

    hasPeriodText: false

    id

    id: number

    is

    is: {
        event: boolean;
        roomSubstitution?: boolean;
        standard?: boolean;
        substitution?: boolean;
    }

    Type declaration

    • event: boolean
    • Optional roomSubstitution?: boolean
    • Optional standard?: boolean
    • Optional substitution?: boolean

    lessonCode

    lessonCode: string

    lessonId

    lessonId: number

    lessonNumber

    lessonNumber: number

    lessonText

    lessonText: string

    periodAttachments

    periodAttachments: []

    periodInfo

    periodInfo: string

    periodText

    periodText: string

    priority

    priority: number

    roomCapacity

    roomCapacity: number

    rooms

    rooms: WebElementData[]

    startTime

    startTime: number

    studentCount

    studentCount: number

    studentGroup

    studentGroup: string

    students

    students: WebElementData[]

    subjects

    subjects: WebElementData[]

    substText

    substText: string

    teachers

    teachers: WebElementData[]

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Properties

    cellState

    cellState: "STANDARD" | "SUBSTITUTION" | "ROOMSUBSTITUTION"

    classes

    classes: WebElementData[]

    code

    code: number

    date

    date: number

    elements

    elements: WebElement[]

    endTime

    endTime: number

    hasInfo

    hasInfo: boolean

    hasPeriodText

    hasPeriodText: false

    id

    id: number

    is

    is: {
        event: boolean;
        roomSubstitution?: boolean;
        standard?: boolean;
        substitution?: boolean;
    }

    Type declaration

    • event: boolean
    • Optional roomSubstitution?: boolean
    • Optional standard?: boolean
    • Optional substitution?: boolean

    lessonCode

    lessonCode: string

    lessonId

    lessonId: number

    lessonNumber

    lessonNumber: number

    lessonText

    lessonText: string

    periodAttachments

    periodAttachments: []

    periodInfo

    periodInfo: string

    periodText

    periodText: string

    priority

    priority: number

    roomCapacity

    roomCapacity: number

    rooms

    rooms: WebElementData[]

    startTime

    startTime: number

    studentCount

    studentCount: number

    studentGroup

    studentGroup: string

    students

    students: WebElementData[]

    subjects

    subjects: WebElementData[]

    substText

    substText: string

    teachers

    teachers: WebElementData[]

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/WebElement.html b/docs/interfaces/WebElement.html index 7a18f23..f5b36ae 100644 --- a/docs/interfaces/WebElement.html +++ b/docs/interfaces/WebElement.html @@ -1,6 +1,6 @@ -WebElement | webuntis

    Interface WebElement

    interface WebElement {
        id: number;
        missing: boolean;
        orgId: number;
        state: "REGULAR" | "ABSENT" | "SUBSTITUTED";
        type: WebUntisElementType;
    }

    Hierarchy (view full)

    Properties

    id +WebElement | webuntis

    Interface WebElement

    interface WebElement {
        id: number;
        missing: boolean;
        orgId: number;
        state: "REGULAR" | "ABSENT" | "SUBSTITUTED";
        type: WebUntisElementType;
    }

    Hierarchy (view full)

    Properties

    id missing orgId state type -

    Properties

    id

    id: number

    missing

    missing: boolean

    orgId

    orgId: number

    state

    state: "REGULAR" | "ABSENT" | "SUBSTITUTED"

    type

    type: WebUntisElementType

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Properties

    id

    id: number

    missing

    missing: boolean

    orgId

    orgId: number

    state

    state: "REGULAR" | "ABSENT" | "SUBSTITUTED"

    type

    type: WebUntisElementType

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/WebElementData.html b/docs/interfaces/WebElementData.html index fb44b84..52fe184 100644 --- a/docs/interfaces/WebElementData.html +++ b/docs/interfaces/WebElementData.html @@ -1,7 +1,7 @@ -WebElementData | webuntis

    Interface WebElementData

    interface WebElementData {
        element: {
            alternatename?: string;
            canViewTimetable: boolean;
            displayname?: string;
            externalKey?: string;
            id: number;
            longName?: string;
            name: string;
            roomCapacity: number;
            type: number;
        };
        id: number;
        missing: boolean;
        orgId: number;
        state: "REGULAR" | "ABSENT" | "SUBSTITUTED";
        type: WebUntisElementType;
    }

    Hierarchy (view full)

    Properties

    element +WebElementData | webuntis

    Interface WebElementData

    interface WebElementData {
        element: {
            alternatename?: string;
            canViewTimetable: boolean;
            displayname?: string;
            externalKey?: string;
            id: number;
            longName?: string;
            name: string;
            roomCapacity: number;
            type: number;
        };
        id: number;
        missing: boolean;
        orgId: number;
        state: "REGULAR" | "ABSENT" | "SUBSTITUTED";
        type: WebUntisElementType;
    }

    Hierarchy (view full)

    Properties

    element id missing orgId state type -

    Properties

    element

    element: {
        alternatename?: string;
        canViewTimetable: boolean;
        displayname?: string;
        externalKey?: string;
        id: number;
        longName?: string;
        name: string;
        roomCapacity: number;
        type: number;
    }

    Type declaration

    • Optional alternatename?: string
    • canViewTimetable: boolean
    • Optional displayname?: string
    • Optional externalKey?: string
    • id: number
    • Optional longName?: string
    • name: string
    • roomCapacity: number
    • type: number

    id

    id: number

    missing

    missing: boolean

    orgId

    orgId: number

    state

    state: "REGULAR" | "ABSENT" | "SUBSTITUTED"

    type

    type: WebUntisElementType

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Properties

    element

    element: {
        alternatename?: string;
        canViewTimetable: boolean;
        displayname?: string;
        externalKey?: string;
        id: number;
        longName?: string;
        name: string;
        roomCapacity: number;
        type: number;
    }

    Type declaration

    • Optional alternatename?: string
    • canViewTimetable: boolean
    • Optional displayname?: string
    • Optional externalKey?: string
    • id: number
    • Optional longName?: string
    • name: string
    • roomCapacity: number
    • type: number

    id

    id: number

    missing

    missing: boolean

    orgId

    orgId: number

    state

    state: "REGULAR" | "ABSENT" | "SUBSTITUTED"

    type

    type: WebUntisElementType

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/types/Authenticator.html b/docs/types/Authenticator.html index b1b7ba1..7726c4d 100644 --- a/docs/types/Authenticator.html +++ b/docs/types/Authenticator.html @@ -1 +1 @@ -Authenticator | webuntis

    Type alias Authenticator

    Authenticator: typeof authenticator

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +Authenticator | webuntis

    Type alias Authenticator

    Authenticator: typeof authenticator

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/types/URLClass.html b/docs/types/URLClass.html index 1f68dc6..7c7eb68 100644 --- a/docs/types/URLClass.html +++ b/docs/types/URLClass.html @@ -1 +1 @@ -URLClass | webuntis

    Type alias URLClassPrivate

    URLClass: typeof URL

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +URLClass | webuntis

    Type alias URLClassPrivate

    URLClass: typeof URL

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file