diff --git a/docs/classes/InternalWebuntisSecretLogin.html b/docs/classes/InternalWebuntisSecretLogin.html index fe1f5b4..c2089b9 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 @@ -51,64 +51,64 @@ 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[]>

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

getClasses

getDepartments

getExamsForRange

getHolidays

getHomeWorkAndLessons

getHomeWorksFor

getInbox

getLatestImportTime

getLatestSchoolyear

getNewsWidget

getOwnClassTimetableFor

getOwnClassTimetableFor

getOwnClassTimetableForRange

getOwnClassTimetableForRange

getOwnClassTimetableForToday

getOwnClassTimetableForToday

getOwnTimetableFor

getOwnTimetableFor

getOwnTimetableForRange

getOwnTimetableForRange

getOwnTimetableForToday

getOwnTimetableForToday

getOwnTimetableForWeek

getOwnTimetableForWeek

getPdfOfAbsentLesson

getRooms

getSchoolyears

getStatusData

getStudents

getSubjects

getTeachers

getTimegrid

getTimetableFor

getTimetableForRange

getTimetableForToday

getTimetableForWeek

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 82054a8..5612194 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 @@ -55,64 +55,64 @@
  • 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[]>

    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

    getAbsentLesson

    getClasses

    getDepartments

    getExamsForRange

    getHolidays

    getHomeWorkAndLessons

    getHomeWorksFor

    getInbox

    getLatestImportTime

    getLatestSchoolyear

    getNewsWidget

    getOwnClassTimetableFor

    getOwnClassTimetableFor

    getOwnClassTimetableForRange

    getOwnClassTimetableForRange

    getOwnClassTimetableForToday

    getOwnClassTimetableForToday

    getOwnTimetableFor

    getOwnTimetableFor

    getOwnTimetableForRange

    getOwnTimetableForRange

    getOwnTimetableForToday

    getOwnTimetableForToday

    getOwnTimetableForWeek

    getOwnTimetableForWeek

    getPdfOfAbsentLesson

    getRooms

    getSchoolyears

    getStatusData

    getStudents

    getSubjects

    getTeachers

    getTimegrid

    getTimetableFor

    getTimetableForRange

    getTimetableForToday

    getTimetableForWeek

    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 1949f0b..d65d458 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 @@ -52,64 +52,64 @@ 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

    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

    getClasses

    getDepartments

    getExamsForRange

    getHolidays

    getHomeWorkAndLessons

    getHomeWorksFor

    getInbox

    getLatestImportTime

    getLatestSchoolyear

    getNewsWidget

    getOwnClassTimetableFor

    getOwnClassTimetableFor

    getOwnClassTimetableForRange

    getOwnClassTimetableForRange

    getOwnClassTimetableForToday

    getOwnClassTimetableForToday

    getOwnTimetableFor

    getOwnTimetableFor

    getOwnTimetableForRange

    getOwnTimetableForRange

    getOwnTimetableForToday

    getOwnTimetableForToday

    getOwnTimetableForWeek

    getOwnTimetableForWeek

    getPdfOfAbsentLesson

    getRooms

    getSchoolyears

    getStatusData

    getStudents

    getSubjects

    getTeachers

    getTimegrid

    getTimetableFor

    getTimetableForRange

    getTimetableForToday

    getTimetableForWeek

    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 160eca3..b6eb324 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 @@ -57,64 +57,64 @@
  • 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[]>

    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

    getClasses

    getDepartments

    getExamsForRange

    getHolidays

    getHomeWorkAndLessons

    getHomeWorksFor

    getInbox

    getLatestImportTime

    getLatestSchoolyear

    getNewsWidget

    getOwnClassTimetableFor

    getOwnClassTimetableFor

    getOwnClassTimetableForRange

    getOwnClassTimetableForRange

    getOwnClassTimetableForToday

    getOwnClassTimetableForToday

    getOwnTimetableFor

    getOwnTimetableFor

    getOwnTimetableForRange

    getOwnTimetableForRange

    getOwnTimetableForToday

    getOwnTimetableForToday

    getOwnTimetableForWeek

    getOwnTimetableForWeek

    getPdfOfAbsentLesson

    getRooms

    getSchoolyears

    getStatusData

    getStudents

    getSubjects

    getTeachers

    getTimegrid

    getTimetableFor

    getTimetableForRange

    getTimetableForToday

    getTimetableForWeek

    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 21fd8d5..1f68142 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 @@ -58,64 +58,64 @@
  • 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

    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

    getClasses

    getDepartments

    getExamsForRange

    getHolidays

    getHomeWorkAndLessons

    getHomeWorksFor

    getInbox

    getLatestImportTime

    getLatestSchoolyear

    getNewsWidget

    getOwnClassTimetableFor

    getOwnClassTimetableFor

    getOwnClassTimetableForRange

    getOwnClassTimetableForRange

    getOwnClassTimetableForToday

    getOwnClassTimetableForToday

    getOwnTimetableFor

    getOwnTimetableFor

    getOwnTimetableForRange

    getOwnTimetableForRange

    getOwnTimetableForToday

    getOwnTimetableForToday

    getOwnTimetableForWeek

    getOwnTimetableForWeek

    getPdfOfAbsentLesson

    getRooms

    getSchoolyears

    getStatusData

    getStudents

    getSubjects

    getTeachers

    getTimegrid

    getTimetableFor

    getTimetableForRange

    getTimetableForToday

    getTimetableForWeek

    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 8487e50..09956fd 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 efff6c8..c2e4a02 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 7842a37..52a96a0 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 203111d..2259708 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 93f78e1..3ef4b42 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 ba9aa1c..418d361 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 b75f443..4470d74 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 5429d5b..4298be3 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 1a3038a..847bc1c 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 b185406..77d0617 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 818bf02..35831e3 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 1bbe841..3c6fd05 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 f7c8ca8..6affa7b 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 42be1fe..91193fd 100644 --- a/docs/interfaces/Klasse.html +++ b/docs/interfaces/Klasse.html @@ -1,5 +1,5 @@ -Klasse | webuntis

    Interface Klasse

    interface Klasse {
        active: boolean;
        id: number;
        longName: string;
        name: string;
    }

    Properties

    active +Klasse | webuntis

    Interface Klasse

    interface Klasse {
        active: boolean;
        id: number;
        longName: string;
        name: string;
    }

    Properties

    active id longName name -

    Properties

    active

    active: boolean

    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

    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/Lesson.html b/docs/interfaces/Lesson.html index bcbf6d0..92dd4df 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 361ae46..fc75a1a 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 f1deeef..c8ba38a 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 86174fb..33f1e03 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 f7b5d7b..a81bf80 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 7299e91..8525ad8 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 1e2f17e..1a6be9a 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 4e4df4a..fb4dd12 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 730c900..3b96505 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 5d5b68c..2c69a83 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 2b7d405..b86ebad 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 93f9460..eb42678 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 d4c2a35..3167e2f 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 1a01979..dc381f8 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 81f1794..ddcc0d2 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 8144ba9..437c031 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 bf556dd..e7e2f4f 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 0ae83e8..7492a84 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 1e9825a..6544f72 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 diff --git a/src/cookie.ts b/src/cookie.ts index 83411f8..5cd37ce 100644 --- a/src/cookie.ts +++ b/src/cookie.ts @@ -39,7 +39,7 @@ export function parse( decode: (str: string) => string; } = { decode: decodeURIComponent, - } + }, ): Record { const obj: Record = {}; const pairs = str.split(pairSplitRegExp); diff --git a/src/qr.ts b/src/qr.ts index 8c7ccaa..770935c 100644 --- a/src/qr.ts +++ b/src/qr.ts @@ -22,13 +22,13 @@ export class WebUntisQR extends WebUntisSecretAuth { identity: string, authenticator: Authenticator, URL?: URLClass, - disableUserAgent = false + disableUserAgent = false, ) { let URLImplementation = URL; if (!URL) { if ('import' in globalThis) { throw new Error( - 'You need to provide the URL object by yourself. We can not eval the require in ESM mode.' + 'You need to provide the URL object by yourself. We can not eval the require in ESM mode.', ); } // React-Native will not eval this expression @@ -42,7 +42,7 @@ export class WebUntisQR extends WebUntisSecretAuth { uri.searchParams.get('url')!, identity, authenticator, - disableUserAgent + disableUserAgent, ); } } diff --git a/src/secret.ts b/src/secret.ts index 125a7a4..a065b41 100644 --- a/src/secret.ts +++ b/src/secret.ts @@ -26,7 +26,7 @@ export class WebUntisSecretAuth extends InternalWebuntisSecretLogin { baseurl: string, identity = 'Awesome', authenticator: Authenticator, - disableUserAgent = false + disableUserAgent = false, ) { super(school, user, null as unknown as string, baseurl, identity, disableUserAgent); this.secret = secret; @@ -34,7 +34,7 @@ export class WebUntisSecretAuth extends InternalWebuntisSecretLogin { if (!authenticator) { if ('import' in globalThis) { throw new Error( - 'You need to provide the otplib object by yourself. We can not eval the require in ESM mode.' + 'You need to provide the otplib object by yourself. We can not eval the require in ESM mode.', ); } // React-Native will not eval this expression