Mercurial > prosody-modules
comparison mod_admin_notify/README.md @ 5975:fe081789f7b5
All community modules: Unify file extention of Markdown files to .md
| author | Menel <menel@snikket.de> |
|---|---|
| date | Tue, 22 Oct 2024 10:26:01 +0200 |
| parents | mod_admin_notify/README.markdown@e97c509fdbe3 |
| children |
comparison
equal
deleted
inserted
replaced
| 5974:5a65a632d5b9 | 5975:fe081789f7b5 |
|---|---|
| 1 --- | |
| 2 labels: | |
| 3 - 'Stage-Alpha' | |
| 4 summary: API to notify server admins | |
| 5 --- | |
| 6 | |
| 7 # Introduction | |
| 8 | |
| 9 This module provides an API for other module developers to send | |
| 10 notification messages to host admins. | |
| 11 | |
| 12 # Configuration | |
| 13 | |
| 14 None required. | |
| 15 | |
| 16 # Developers | |
| 17 | |
| 18 Example: | |
| 19 | |
| 20 ``` | |
| 21 local notify_admins = module:depends("admin_notify").notify; | |
| 22 | |
| 23 notify("This is an important message for you, admins") | |
| 24 ``` | |
| 25 | |
| 26 # Compatibility | |
| 27 | |
| 28 Prosody trunk or later. Incompatible with 0.11 or lower. |