Mercurial > prosody-modules

annotate mod_csi_muc_priorities/README.md @ 6562:5da6fb562df9 default tip

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
mod_unified_push: Fix push error handling (fixes #2000) Use the error object that send_iq() passes as an argument to it's reject callback instead of attempting and failing to do the parsing in the callback itself.
author kmq
date Mon, 06 Jul 2026 14:23:57 +0200
parents 79153a59dd4e
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
6457
79153a59dd4e mod_csi_muc_priorities/README.md: Set Stage and Compatibility
Menel <menel@snikket.de>
parents: 5975
diff changeset
1 ---
79153a59dd4e mod_csi_muc_priorities/README.md: Set Stage and Compatibility
Menel <menel@snikket.de>
parents: 5975
diff changeset
2 summary: Save energy by setting csi priority groupchats
79153a59dd4e mod_csi_muc_priorities/README.md: Set Stage and Compatibility
Menel <menel@snikket.de>
parents: 5975
diff changeset
3 labels:
79153a59dd4e mod_csi_muc_priorities/README.md: Set Stage and Compatibility
Menel <menel@snikket.de>
parents: 5975
diff changeset
4 - 'Stage-Beta'
79153a59dd4e mod_csi_muc_priorities/README.md: Set Stage and Compatibility
Menel <menel@snikket.de>
parents: 5975
diff changeset
5 ...
79153a59dd4e mod_csi_muc_priorities/README.md: Set Stage and Compatibility
Menel <menel@snikket.de>
parents: 5975
diff changeset
6
3545
c1d7e6752d18 mod_csi_muc_priorities: Add a README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
7 # Introduction
c1d7e6752d18 mod_csi_muc_priorities: Add a README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
8
c1d7e6752d18 mod_csi_muc_priorities: Add a README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
9 This module lets users specify which of the group chats they are in are
5969
d3812826c1cd mod_csi_muc_priorities: Allow setting the default priority for mucs to low
aereaux <aidan@jmad.org>
parents: 3639
diff changeset
10 more or less important. This influences when
3545
c1d7e6752d18 mod_csi_muc_priorities: Add a README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
11 [mod_csi_simple][doc:modules:mod_csi_simple] decides to send
c1d7e6752d18 mod_csi_muc_priorities: Add a README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
12 stanzas vs waiting until there is more to send. Users in many large
c1d7e6752d18 mod_csi_muc_priorities: Add a README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
13 public channels might benefit from this.
c1d7e6752d18 mod_csi_muc_priorities: Add a README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
14
c1d7e6752d18 mod_csi_muc_priorities: Add a README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
15 # Configuration
c1d7e6752d18 mod_csi_muc_priorities: Add a README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
16
c1d7e6752d18 mod_csi_muc_priorities: Add a README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
17 The module is configured via ad-hoc an command called *Configure group
c1d7e6752d18 mod_csi_muc_priorities: Add a README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
18 chat priorities* that should appear in the menus of compatible clients.
c1d7e6752d18 mod_csi_muc_priorities: Add a README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
19
c1d7e6752d18 mod_csi_muc_priorities: Add a README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
20 The command presents a form that accepts a list of XMPP addresses.
5969
d3812826c1cd mod_csi_muc_priorities: Allow setting the default priority for mucs to low
aereaux <aidan@jmad.org>
parents: 3639
diff changeset
21 Currently you can specify channels as lower priority (which is suitable
d3812826c1cd mod_csi_muc_priorities: Allow setting the default priority for mucs to low
aereaux <aidan@jmad.org>
parents: 3639
diff changeset
22 for e.g. noisy public channels) or higher priority (which is suitable
d3812826c1cd mod_csi_muc_priorities: Allow setting the default priority for mucs to low
aereaux <aidan@jmad.org>
parents: 3639
diff changeset
23 for e.g. small private channels where immediate message delivery is
d3812826c1cd mod_csi_muc_priorities: Allow setting the default priority for mucs to low
aereaux <aidan@jmad.org>
parents: 3639
diff changeset
24 desired). You can also specify whether mucs default to lower priority
d3812826c1cd mod_csi_muc_priorities: Allow setting the default priority for mucs to low
aereaux <aidan@jmad.org>
parents: 3639
diff changeset
25 or not.
3545
c1d7e6752d18 mod_csi_muc_priorities: Add a README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
26
5969
d3812826c1cd mod_csi_muc_priorities: Allow setting the default priority for mucs to low
aereaux <aidan@jmad.org>
parents: 3639
diff changeset
27 A message of type groupchat from an address in the low priority list will
d3812826c1cd mod_csi_muc_priorities: Allow setting the default priority for mucs to low
aereaux <aidan@jmad.org>
parents: 3639
diff changeset
28 not be considered important enough to send it to an inactive client,
d3812826c1cd mod_csi_muc_priorities: Allow setting the default priority for mucs to low
aereaux <aidan@jmad.org>
parents: 3639
diff changeset
29 unless it is from the current user or mentions of their nickname.
d3812826c1cd mod_csi_muc_priorities: Allow setting the default priority for mucs to low
aereaux <aidan@jmad.org>
parents: 3639
diff changeset
30 **Note** that mention support require the separate module
d3812826c1cd mod_csi_muc_priorities: Allow setting the default priority for mucs to low
aereaux <aidan@jmad.org>
parents: 3639
diff changeset
31 [mod_track_muc_joins] to also be loaded.
3639
562d3b219876 mod_csi_muc_priorities: Add an example
Kim Alvefur <zash@zash.se>
parents: 3638
diff changeset
32
562d3b219876 mod_csi_muc_priorities: Add an example
Kim Alvefur <zash@zash.se>
parents: 3638
diff changeset
33 ``` {.lua}
562d3b219876 mod_csi_muc_priorities: Add an example
Kim Alvefur <zash@zash.se>
parents: 3638
diff changeset
34 modules_enabled = {
562d3b219876 mod_csi_muc_priorities: Add an example
Kim Alvefur <zash@zash.se>
parents: 3638
diff changeset
35 -- other modules etc
562d3b219876 mod_csi_muc_priorities: Add an example
Kim Alvefur <zash@zash.se>
parents: 3638
diff changeset
36
562d3b219876 mod_csi_muc_priorities: Add an example
Kim Alvefur <zash@zash.se>
parents: 3638
diff changeset
37 "csi_simple",
562d3b219876 mod_csi_muc_priorities: Add an example
Kim Alvefur <zash@zash.se>
parents: 3638
diff changeset
38 "csi_muc_priorities",
562d3b219876 mod_csi_muc_priorities: Add an example
Kim Alvefur <zash@zash.se>
parents: 3638
diff changeset
39 "track_muc_joins", -- optional
562d3b219876 mod_csi_muc_priorities: Add an example
Kim Alvefur <zash@zash.se>
parents: 3638
diff changeset
40 }
562d3b219876 mod_csi_muc_priorities: Add an example
Kim Alvefur <zash@zash.se>
parents: 3638
diff changeset
41 ```
6457
79153a59dd4e mod_csi_muc_priorities/README.md: Set Stage and Compatibility
Menel <menel@snikket.de>
parents: 5975
diff changeset
42
79153a59dd4e mod_csi_muc_priorities/README.md: Set Stage and Compatibility
Menel <menel@snikket.de>
parents: 5975
diff changeset
43 # Todo
79153a59dd4e mod_csi_muc_priorities/README.md: Set Stage and Compatibility
Menel <menel@snikket.de>
parents: 5975
diff changeset
44
79153a59dd4e mod_csi_muc_priorities/README.md: Set Stage and Compatibility
Menel <menel@snikket.de>
parents: 5975
diff changeset
45 Set default priority for public and private channels seperately
79153a59dd4e mod_csi_muc_priorities/README.md: Set Stage and Compatibility
Menel <menel@snikket.de>
parents: 5975
diff changeset
46
79153a59dd4e mod_csi_muc_priorities/README.md: Set Stage and Compatibility
Menel <menel@snikket.de>
parents: 5975
diff changeset
47 # Compatibility
79153a59dd4e mod_csi_muc_priorities/README.md: Set Stage and Compatibility
Menel <menel@snikket.de>
parents: 5975
diff changeset
48
79153a59dd4e mod_csi_muc_priorities/README.md: Set Stage and Compatibility
Menel <menel@snikket.de>
parents: 5975
diff changeset
49 Works with Prosody Version >= 0.12