Zermelo

zermelo~ Zermelo

(private) new Zermelo(apiUrl, sessionInfo)

Source:
Parameters:
Name Type Description
apiUrl String
sessionInfo SessionInfo

Methods

(private) _url(slug) → {String}

Source:

Builds an url with this._apiUrl and the current's session accessToken, while adding slug.

Parameters:
Name Type Description
slug String
Returns:
Type
String

announcements(optionsopt) → {Promise.<Array.<Announcement>>}

Source:
Parameters:
Name Type Attributes Default Description
options Object <optional>
 {}
Properties
Name Type Attributes Default Description
current Boolean <optional>
 true
from Date <optional>

Time is ignored.
to Date <optional>

Time is ignored.
Returns:
Type
Promise.<Array.<Announcement>>

appointments(from, toopt, optionsopt) → {Promise.<Array.<Appointment>>}

Source:
Parameters:
Name Type Attributes Default Description
from Date
to Date <optional>
 from + 1 day
options Object <optional>
 {}
Properties
Name Type Attributes Default Description
onlyBase Boolean <optional>
 false

If true only base apopointments are given.
latest Boolean <optional>

If true only the latest appointments are given, if false only the non-latest appointments are given, and when undefined this option is ignored.
cancelled Boolean <optional>

If true only cancelled appointments are given, if false only non-cancelled appointments are given, and when undefined this option is ignored.
includeHidden Boolean <optional>
 false

Whether or not to include hidden appointments.
modifiedSince Date <optional>

When this is not undefined, options.latest will be set to undefined.
ignoreTime Boolean <optional>
 true

If true the time is set to 00:00 for both from and to.
Returns:
Type
Promise.<Array.<Appointment>>

school() → {Promise.<School>}

Source:
Returns:
Type
Promise.<School>

userInfo() → {Promise.<User>}

Source:
Returns:
Type
Promise.<User>