import { school } from "../webuntis/resources/index.js"; import { UntisClient } from "../UntisClient.js"; /** * Wrapper around the school objects returned by the WebUntis API. */ export declare class School { /** * The WebUntis server that is used by this school. Is `xxx.webuntis.com`, i.e. `ikarus.webuntis.com`. */ readonly server: string; readonly useMobileServiceUrlAndroid: boolean; /** * The school's address. */ readonly address: string; /** * The school's full name. */ readonly displayName: string; /** * Shortened, unique name for this school. */ readonly loginName: string; /** * The school's id. */ readonly id: number; readonly useMobileServiceUrlIos: boolean; /** * URL to the WebUntis server. Is `https://{server}/WebUntis/?school={loginName}`. */ readonly serverUrl: string; readonly mobileServiceUrl: string | null; constructor( /** * The WebUntis server that is used by this school. Is `xxx.webuntis.com`, i.e. `ikarus.webuntis.com`. */ server: string, useMobileServiceUrlAndroid: boolean, /** * The school's address. */ address: string, /** * The school's full name. */ displayName: string, /** * Shortened, unique name for this school. */ loginName: string, /** * The school's id. */ id: number, useMobileServiceUrlIos: boolean, /** * URL to the WebUntis server. Is `https://{server}/WebUntis/?school={loginName}`. */ serverUrl: string, mobileServiceUrl: string | null); /** * Creates a new {@link UntisClient} for logging in as a user from this school. * @returns the client */ getClient: () => UntisClient; /** * Creates a new instance of this class. * @param school the school returned by WebUntis. * @returns the new instance */ static from(school: school): School; }