Software / code / prosody-modules
Diff
mod_csi_muc_priorities/README.markdown @ 5997:d3812826c1cd
mod_csi_muc_priorities: Allow setting the default priority for mucs to low
Move the priority checking after the mention check so that if there is a
mention we return true.
Add an option to the form to set the default priority to low.
Return `nil` in cases where we determite that the priority should be high, as
with `mod_csi_simple` this causes normal MUC messages to be marked important
while allowing mod_csi_grace_period and unneeded messages to be queued.
| author | aereaux <aidan@jmad.org> |
|---|---|
| date | Sun, 22 Sep 2024 08:13:09 -0700 |
| parent | 3639:562d3b219876 |
line wrap: on
line diff
--- a/mod_csi_muc_priorities/README.markdown Tue Oct 08 22:23:57 2024 +0200 +++ b/mod_csi_muc_priorities/README.markdown Sun Sep 22 08:13:09 2024 -0700 @@ -1,7 +1,7 @@ # Introduction This module lets users specify which of the group chats they are in are -less important. This influences when +more or less important. This influences when [mod_csi_simple][doc:modules:mod_csi_simple] decides to send stanzas vs waiting until there is more to send. Users in many large public channels might benefit from this. @@ -12,16 +12,17 @@ chat priorities* that should appear in the menus of compatible clients. The command presents a form that accepts a list of XMPP addresses. -Currently there is a single priority, *Lower priority*, which is -suitable for e.g. noisy public channels. mod_csi_simple considers -groupchat messages important by default on the assumptions that smaller -and more important private chats are more common among most users. +Currently you can specify channels as lower priority (which is suitable +for e.g. noisy public channels) or higher priority (which is suitable +for e.g. small private channels where immediate message delivery is +desired). You can also specify whether mucs default to lower priority +or not. -A message of type groupchat from an address in this list will not be -considered important enough to send it to an inactive client, unless it -is from the current user or mentions of their nickname. **Note** that -mention support require the separate module [mod_track_muc_joins] -to also be loaded. +A message of type groupchat from an address in the low priority list will +not be considered important enough to send it to an inactive client, +unless it is from the current user or mentions of their nickname. +**Note** that mention support require the separate module +[mod_track_muc_joins] to also be loaded. ``` {.lua} modules_enabled = {
