Class WebUntisSecretAuth

Hierarchy (view full)

InternalWebuntisSecretLogin
- WebUntisSecretAuth
  - WebUntisQR

Index

Constructors

constructor

Properties

anonymous authenticator axios baseurl cookies id password school schoolbase64 secret sessionInformation username TYPES

Constructors

constructor

new WebUntisSecretAuth(school, user, secret, baseurl, identity?, authenticator, disableUserAgent?): WebUntisSecretAuth
Parameters
- school: string
  The school identifier
- user: string
- secret: string
- baseurl: string
  Just the host name of your WebUntis (Example: mese.webuntis.com)
- 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
Overrides InternalWebuntisSecretLogin.constructor
- Defined in secret.ts:22

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

_buildCookies(): string
Private
Returns string
Inherited from InternalWebuntisSecretLogin._buildCookies
- Defined in base.ts:261

`Private` _getCookieFromSetCookie

_getCookieFromSetCookie(setCookieArray?, cookieName?): undefined | string
Private
Parameters
- Optional setCookieArray: string[]
- Optional cookieName: string = 'JSESSIONID'
Returns undefined | string
Inherited from InternalWebuntisSecretLogin._getCookieFromSetCookie
- Defined in base.ts:1048

`Private` _getJWT

_getJWT(validateSession?): Promise<string>
Private
Get JWT Token
Parameters
- validateSession: boolean = true
Returns Promise<string>
Inherited from InternalWebuntisSecretLogin._getJWT
- Defined in base.ts:272

_otpLogin

_otpLogin(token, username, time, skipSessionInfo?): Promise<SessionInformation>
Parameters
- token: string | number
- username: string
- time: number
- skipSessionInfo: boolean = false
Returns Promise<SessionInformation>
Inherited from InternalWebuntisSecretLogin._otpLogin
- Defined in base.ts:948

`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>
Inherited from InternalWebuntisSecretLogin._request
- Defined in base.ts:825

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>
Inherited from InternalWebuntisSecretLogin.getAbsentLesson
- Defined in base.ts:861

getClasses

getClasses(validateSession?, schoolyearId): Promise<Klasse[]>
Get all classes known by WebUntis
Parameters
- Optional validateSession: boolean = true
- schoolyearId: number
Returns Promise<Klasse[]>
Inherited from InternalWebuntisSecretLogin.getClasses
- Defined in base.ts:753

getCurrentSchoolyear

getCurrentSchoolyear(validateSession?): Promise<SchoolYear>
Get the current school year
Parameters
- Optional validateSession: boolean = true
Returns Promise<SchoolYear>
Inherited from InternalWebuntisSecretLogin.getCurrentSchoolyear
- Defined in base.ts:790

getDepartments

getDepartments(validateSession?): Promise<Department[]>
Get all departments known by WebUntis
Parameters
- Optional validateSession: boolean = true
Returns Promise<Department[]>
Inherited from InternalWebuntisSecretLogin.getDepartments
- Defined in base.ts:763

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[]>
Inherited from InternalWebuntisSecretLogin.getExamsForRange
- Defined in base.ts:602

getHolidays

getHolidays(validateSession?): Promise<Holiday[]>
Get all holidays known by WebUntis
Parameters
- Optional validateSession: boolean = true
Returns Promise<Holiday[]>
Inherited from InternalWebuntisSecretLogin.getHolidays
- Defined in base.ts:772

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[]>
Inherited from InternalWebuntisSecretLogin.getHomeWorkAndLessons
- Defined in base.ts:576

getHomeWorksFor

getHomeWorksFor(rangeStart, rangeEnd, validateSession?): Promise<Homework[]>
Parameters
- rangeStart: Date
- rangeEnd: Date
- Optional validateSession: boolean = true
Returns Promise<Homework[]>
Inherited from InternalWebuntisSecretLogin.getHomeWorksFor
- Defined in base.ts:511

getInbox

getInbox(validateSession?): Promise<Inbox>
Get Inbox
Parameters
- validateSession: boolean = true
Returns Promise<Inbox>
Inherited from InternalWebuntisSecretLogin.getInbox
- Defined in base.ts:233

getLatestImportTime

getLatestImportTime(validateSession?): Promise<number>
Get the time when WebUntis last changed its data
Parameters
- Optional validateSession: boolean = true
Returns Promise<number>
Inherited from InternalWebuntisSecretLogin.getLatestImportTime
- Defined in base.ts:316

getLatestSchoolyear

getLatestSchoolyear(validateSession?): Promise<SchoolYear>
Get the latest WebUntis Schoolyear
Parameters
- Optional validateSession: boolean = true
Returns Promise<SchoolYear>
Inherited from InternalWebuntisSecretLogin.getLatestSchoolyear
- Defined in base.ts:170

getNewsWidget

getNewsWidget(date, validateSession?): Promise<NewsWidget>
Get News Widget
Parameters
- date: Date
- Optional validateSession: boolean = true
Returns Promise<NewsWidget>
see index.d.ts NewsWidget
Inherited from InternalWebuntisSecretLogin.getNewsWidget
- Defined in base.ts:214

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[]>
Inherited from InternalWebuntisSecretLogin.getOwnClassTimetableFor
- Defined in base.ts:481

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[]>
Inherited from InternalWebuntisSecretLogin.getOwnClassTimetableForRange
- Defined in base.ts:493

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[]>
Inherited from InternalWebuntisSecretLogin.getOwnClassTimetableForToday
- Defined in base.ts:469

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[]>
Inherited from InternalWebuntisSecretLogin.getOwnTimetableFor
- Defined in base.ts:404

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[]>
Inherited from InternalWebuntisSecretLogin.getOwnTimetableForRange
- Defined in base.ts:434

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[]>
Inherited from InternalWebuntisSecretLogin.getOwnTimetableForToday
- Defined in base.ts:376

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[]>
Inherited from InternalWebuntisSecretLogin.getOwnTimetableForWeek
- Defined in base.ts:709

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>
Inherited from InternalWebuntisSecretLogin.getPdfOfAbsentLesson
- Defined in base.ts:896

getRooms

getRooms(validateSession?): Promise<Room[]>
Get all known rooms by WebUntis
Parameters
- Optional validateSession: boolean = true
Returns Promise<Room[]>
Inherited from InternalWebuntisSecretLogin.getRooms
- Defined in base.ts:743

getSchoolyears

getSchoolyears(validateSession?): Promise<SchoolYear[]>
Get all WebUntis Schoolyears
Parameters
- Optional validateSession: boolean = true
Returns Promise<SchoolYear[]>
Inherited from InternalWebuntisSecretLogin.getSchoolyears
- Defined in base.ts:190

getStatusData

getStatusData(validateSession?): Promise<StatusData>
Get all status data known by WebUntis
Parameters
- Optional validateSession: boolean = true
Returns Promise<StatusData>
Inherited from InternalWebuntisSecretLogin.getStatusData
- Defined in base.ts:781

getStudents

getStudents(validateSession?): Promise<Student[]>
Get all known students by WebUntis
Parameters
- Optional validateSession: boolean = true
Returns Promise<Student[]>
Inherited from InternalWebuntisSecretLogin.getStudents
- Defined in base.ts:734

getSubjects

getSubjects(validateSession?): Promise<Subject[]>
Get all known Subjects for the current logged-in user
Parameters
- Optional validateSession: boolean = true
Returns Promise<Subject[]>
Inherited from InternalWebuntisSecretLogin.getSubjects
- Defined in base.ts:555

getTeachers

getTeachers(validateSession?): Promise<Teacher[]>
Get all known teachers by WebUntis
Parameters
- Optional validateSession: boolean = true
Returns Promise<Teacher[]>
Inherited from InternalWebuntisSecretLogin.getTeachers
- Defined in base.ts:725

getTimegrid

getTimegrid(validateSession?): Promise<Timegrid[]>
Get the timegrid of current school
Parameters
- Optional validateSession: boolean = true
Returns Promise<Timegrid[]>
Inherited from InternalWebuntisSecretLogin.getTimegrid
- Defined in base.ts:564

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[]>
Inherited from InternalWebuntisSecretLogin.getTimetableFor
- Defined in base.ts:422

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[]>
Inherited from InternalWebuntisSecretLogin.getTimetableForRange
- Defined in base.ts:453

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[]>
Inherited from InternalWebuntisSecretLogin.getTimetableForToday
- Defined in base.ts:394

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[]>
Inherited from InternalWebuntisSecretLogin.getTimetableForWeek
- Defined in base.ts:636

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>
Overrides InternalWebuntisSecretLogin.login
- Defined in secret.ts:47

logout

logout(): Promise<boolean>
Logout the current session

Returns Promise<boolean>
Inherited from InternalWebuntisSecretLogin.logout
- Defined in base.ts:114

validateSession

validateSession(): Promise<boolean>
Checks if your current WebUntis Session is valid

Returns Promise<boolean>
Inherited from InternalWebuntisSecretLogin.validateSession
- Defined in base.ts:291

`Static` convertDateToUntis

convertDateToUntis(date): string
Convert a JS Date Object to a WebUntis date string
Parameters
- date: Date
Returns string
Inherited from InternalWebuntisSecretLogin.convertDateToUntis
- Defined in base.ts:808

`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
Inherited from InternalWebuntisSecretLogin.convertUntisDate
- Defined in base.ts:535

`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
Inherited from InternalWebuntisSecretLogin.convertUntisTime
- Defined in base.ts:546

Class WebUntisSecretAuth

Hierarchy (view full)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

school: string

user: string

secret: string

baseurl: string

Optional identity: string = 'Awesome'

authenticator: Authenticator<AuthenticatorOptions<string>>

Optional disableUserAgent: boolean = false

Returns WebUntisSecretAuth

Properties

anonymous

Private authenticator

axios

baseurl

cookies

id

password

school

schoolbase64

Private Readonly secret

sessionInformation

username

Static TYPES

Methods

Private _buildCookies

Returns string

Private _getCookieFromSetCookie

Parameters

Optional setCookieArray: string[]

Optional cookieName: string = 'JSESSIONID'

Returns undefined | string

Private _getJWT

Parameters

validateSession: boolean = true

Returns Promise<string>

_otpLogin

Parameters

token: string | number

username: string

time: number

skipSessionInfo: boolean = false

Returns Promise<SessionInformation>

Private _request

Type Parameters

Response = Record<string, any>

Parameters

method: string

Optional parameter: Record<string, any> = {}

Optional validateSession: boolean = true

Optional url: string = ...

Returns Promise<Response>

getAbsentLesson

Parameters

rangeStart: Date

rangeEnd: Date

Optional excuseStatusId: number = -1

Optional validateSession: boolean = true

Returns Promise<Absences>

getClasses

Parameters

Optional validateSession: boolean = true

schoolyearId: number

Returns Promise<Klasse[]>

getCurrentSchoolyear

Parameters

Optional validateSession: boolean = true

Returns Promise<SchoolYear>

getDepartments

Parameters

Optional validateSession: boolean = true

Returns Promise<Department[]>

getExamsForRange

`Optional` identity: string = 'Awesome'

`Optional` disableUserAgent: boolean = false

`Private` authenticator

`Private` `Readonly` secret

`Static` TYPES

`Private` _buildCookies

`Private` _getCookieFromSetCookie

`Optional` setCookieArray: string[]

`Optional` cookieName: string = 'JSESSIONID'

`Private` _getJWT

`Private` _request

`Optional` parameter: Record<string, any> = {}

`Optional` validateSession: boolean = true

`Optional` url: string = ...

`Optional` excuseStatusId: number = -1

`Optional` validateSession: boolean = true

`Optional` validateSession: boolean = true

`Optional` validateSession: boolean = true

`Optional` validateSession: boolean = true

`Optional` validateSession: boolean = true

`Optional` validateSession: boolean = true

`Optional` validateSession: boolean = true

`Optional` validateSession: boolean = true

`Optional` validateSession: boolean = true

`Optional` validateSession: boolean = true

`Optional` validateSession: boolean = true

`Optional` validateSession: boolean = true

`Optional` validateSession: boolean = true

`Optional` validateSession: boolean = true

`Optional` validateSession: boolean = true

`Optional` validateSession: boolean = true

`Optional` validateSession: boolean = true