Ntfy Configuration
On this page
A Notifier that sends push notifications via the Ntfy service. Requires the user to have the Ntfy app installed on their phone (e.g. Android or have opened the Progressive Web App. Moreover, it is necessary that the user has subscribed to a specific topic on a Ntfy server.
Class Diagram
Instantiation
In order to create a new NtfyNotifier, you need to provide the topic that the user has subscribed to on the Ntfy server in use:
NtfyNotifier ntfyNotifier = new NtfyNotifier("friedolyn-es13nsa");
Settings
Note
Javadoc has sadly not recognised the Lombok getters for all fields, but they do exist.
Host
The domain name of the Ntfy server that shall relay the push notifications to the user’s device.
Type | String |
JSON key | host |
Default | ntfy.adminforge.de by AdminForge |
Example | ntfy.sh |
URL
The URL of the Ntfy server that shall relay the push notifications to the user’s device.
Type | URL |
JSON key | url |
Default | https://ntfy.adminforge.de |
Exmaple | https://ntfy.sh |
Topic
The (hopefully unique) topic that the user has subscribed to on the Ntfy server and where all push notifications shall be sent to. Must not be blank.
Type | String |
JSON key | topic |
Default | none (must be provided via constructor) |
Examples |
|