diff -r 362ca94192ee -r 6ab46ff685d0 mod_cloud_notify/README.markdown --- a/mod_cloud_notify/README.markdown Sat Mar 11 01:37:28 2017 +0100 +++ b/mod_cloud_notify/README.markdown Sat Mar 11 01:42:45 2017 +0100 @@ -16,8 +16,9 @@ Details ======= -App servers are notified about offline messages or messages waiting -in the smacks queue. +App servers are notified about offline messages, messages stored by [mod_mam] +or messages waiting in the smacks queue. +The business rules outlined [here] are all honored[^2]. To cooperate with [mod_smacks] this module consumes some events: "smacks-ack-delayed", "smacks-hibernation-start" and "smacks-hibernation-end". @@ -32,6 +33,10 @@ request in a timely manner, thus allowing conversations to be smoother under such circumstances. +The new event "cloud-notify-ping" can be used by any module to send out a cloud +notification to either all registered endpoints for the given user or only the endpoints +given in the event data. + Configuration ============= @@ -61,4 +66,5 @@ [^1]: The service which is expected to forward notifications to something like Google Cloud Messaging or Apple Notification Service -[mod_smacks]: //modules.prosody.im/mod_smacks +[here]: https://mail.jabber.org/pipermail/standards/2016-February/030925.html +[^2]: //hg.prosody.im/prosody-modules/file/tip/mod_cloud_notify/business_rules.md