Title here
Summary here
Notifications Configuration
Class Diagram
Instantiation
Since the contact methods include the student’s Matrix account
at the university’s Matrix server, the student’s username is required to build their
Matrix ID which is written in the format @username:uni-jena.de, e.g. @es13nsa:uni-jena.de.
ContactMethods contactMethods = new ContactMethods("es13nsa");
assert contactMethods.getMatrixID().isPresent();
assert contactMethods.getMatrixID().get().equals("@es13nsa:uni-jena.de");Settings
Include grades in notifications
Whether to reveal the new grades in the notifications sent to the user.
| Type | IncludeGrades |
| Must be one of |
|
| JSON key | include-grades |
| Default | ONLY_GOOD_ONES |
Note
Javadoc has sadly not recognised the Lombok getter and setter for the include-grades field, but they do exist.
Good grades threshold
This grade and all grades better that it will be included in the notification. Worse grades will not be revealed.
| Type | German school grade, i.e. 1.0 <= double <= 4.0 |
| JSON key | good-grades-threshold |
| Default | 2.5 |
Note
Javadoc has sadly not recognised the Lombok getter for the good-grades-threshold field, but it does exist.
Ntfy notifier
The notifier that will be used to send the push notifications to the user’s device via the Ntfy service.
| Type | NtfyNotifier |
| JSON key | ntfy-notifier |
| Default | none |
UnifiedPush notifier
The notifier that will be used to send the push notifications to the user’s device via the UnifiedPush service.
| Type | UnifiedPushNotifier |
| JSON key | unifiedpush-notifier |
| Default | none |