Class WebUntisQR

Hierarchy (view full)

Constructors

constructor

Properties

anonymous axios baseurl cookies id password school schoolbase64 sessionInformation username TYPES

Methods

_buildCookies _getCookieFromSetCookie _getJWT _otpLogin _request getAbsentLesson getClasses getCurrentSchoolyear getDepartments getExamsForRange getHolidays getHomeWorkAndLessons getHomeWorksFor getInbox getLatestImportTime getLatestSchoolyear getNewsWidget getOwnClassTimetableFor getOwnClassTimetableForRange getOwnClassTimetableForToday getOwnTimetableFor getOwnTimetableForRange getOwnTimetableForToday getOwnTimetableForWeek getPdfOfAbsentLesson getRooms getSchoolyears getStatusData getStudents getSubjects getTeachers getTimegrid getTimetableFor getTimetableForRange getTimetableForToday getTimetableForWeek login logout validateSession convertDateToUntis convertUntisDate convertUntisTime

Constructors

constructor

  • new WebUntisQR(QRCodeURI, identity?, authenticator, URL?, disableUserAgent?): WebUntisQR

  • Use the data you get from a WebUntis QR code

    Parameters

    • QRCodeURI: string

      A WebUntis uri. This is the data you get from the QR Code from the webuntis webapp under profile->Data access->Display

    • Optional identity: string

      A identity like: MyAwesomeApp

    • 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

    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

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 Note: You can't use this with anonymous login

    Parameters

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

    Returns Promise<Lesson[]>

getOwnClassTimetableForToday

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 Note: You can't use this with anonymous login

    Parameters

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

    Returns Promise<Lesson[]>

getOwnTimetableForToday

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.

    Parameters

    • date: Date

      one date in the week to query

    • id: number

      element id

    • type: number

      element type

    • Optional formatId: number = 1

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

    • Optional validateSession: boolean = true

    Returns Promise<WebAPITimetable[]>

login

  • login(): Promise<SessionInformation>

  • Login with your credentials

    Notice: The server may revoke this session after less than 10min of idle.

    Untis says in the official docs:

    An application should always log out as soon as possible to free system resources on the server.

    Returns Promise<SessionInformation>

logout

validateSession

Static convertDateToUntis

Static convertUntisDate

  • convertUntisDate(date, baseDate?): Date

  • Converts the untis date string format to a normal JS Date object

    Parameters

    • date: string

      Untis date string

    • Optional baseDate: Date = ...

      Base date. Default beginning of current day

    Returns Date

    Static

Static convertUntisTime

  • convertUntisTime(time, baseDate?): Date

  • Convert a untis time string to a JS Date object

    Parameters

    • time: string | number

      Untis time string

    • Optional baseDate: Date = ...

      Day used as base for the time. Default: Current date

    Returns Date

    Static

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc