Software / code / prosody-modules
Annotate
mod_csi_muc_priorities/README.markdown @ 5366:db4c66a1d24b
mod_http_oauth2: Fill in some client metadata defaults
Explicit > Implicit
Maybe we should actually use these for something as well? :)
It's is somewhat an open question of how strictly we should enforce
things in the client metadata given that it is somewhat extensible.
Especially some of these enum fields which have corresponding IANA
registries.
| author | Kim Alvefur <zash@zash.se> |
|---|---|
| date | Tue, 25 Apr 2023 18:09:08 +0200 |
| parent | 3639:562d3b219876 |
| rev | line source |
|---|---|
|
3545
c1d7e6752d18
mod_csi_muc_priorities: Add a README
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
1 # Introduction |
|
c1d7e6752d18
mod_csi_muc_priorities: Add a README
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
2 |
|
c1d7e6752d18
mod_csi_muc_priorities: Add a README
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
3 This module lets users specify which of the group chats they are in are |
|
c1d7e6752d18
mod_csi_muc_priorities: Add a README
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
4 less important. This influences when |
|
c1d7e6752d18
mod_csi_muc_priorities: Add a README
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
5 [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
|
6 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
|
7 public channels might benefit from this. |
|
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 # Configuration |
|
c1d7e6752d18
mod_csi_muc_priorities: Add a README
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
10 |
|
c1d7e6752d18
mod_csi_muc_priorities: Add a README
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
11 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
|
12 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
|
13 |
|
c1d7e6752d18
mod_csi_muc_priorities: Add a README
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
14 The command presents a form that accepts a list of XMPP addresses. |
|
c1d7e6752d18
mod_csi_muc_priorities: Add a README
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
15 Currently there is a single priority, *Lower priority*, which is |
|
c1d7e6752d18
mod_csi_muc_priorities: Add a README
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
16 suitable for e.g. noisy public channels. mod_csi_simple considers |
|
c1d7e6752d18
mod_csi_muc_priorities: Add a README
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
17 groupchat messages important by default on the assumptions that smaller |
|
c1d7e6752d18
mod_csi_muc_priorities: Add a README
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
18 and more important private chats are more common among most users. |
|
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 A message of type groupchat from an address in this list will not be |
|
c1d7e6752d18
mod_csi_muc_priorities: Add a README
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
21 considered important enough to send it to an inactive client, unless it |
|
3638
6f3e878537f4
mod_csi_muc_priorities: Mention mod_track_muc_joins
Kim Alvefur <zash@zash.se>
parents:
3545
diff
changeset
|
22 is from the current user or mentions of their nickname. **Note** that |
|
6f3e878537f4
mod_csi_muc_priorities: Mention mod_track_muc_joins
Kim Alvefur <zash@zash.se>
parents:
3545
diff
changeset
|
23 mention support require the separate module [mod_track_muc_joins] |
|
6f3e878537f4
mod_csi_muc_priorities: Mention mod_track_muc_joins
Kim Alvefur <zash@zash.se>
parents:
3545
diff
changeset
|
24 to also be loaded. |
|
3639
562d3b219876
mod_csi_muc_priorities: Add an example
Kim Alvefur <zash@zash.se>
parents:
3638
diff
changeset
|
25 |
|
562d3b219876
mod_csi_muc_priorities: Add an example
Kim Alvefur <zash@zash.se>
parents:
3638
diff
changeset
|
26 ``` {.lua} |
|
562d3b219876
mod_csi_muc_priorities: Add an example
Kim Alvefur <zash@zash.se>
parents:
3638
diff
changeset
|
27 modules_enabled = { |
|
562d3b219876
mod_csi_muc_priorities: Add an example
Kim Alvefur <zash@zash.se>
parents:
3638
diff
changeset
|
28 -- other modules etc |
|
562d3b219876
mod_csi_muc_priorities: Add an example
Kim Alvefur <zash@zash.se>
parents:
3638
diff
changeset
|
29 |
|
562d3b219876
mod_csi_muc_priorities: Add an example
Kim Alvefur <zash@zash.se>
parents:
3638
diff
changeset
|
30 "csi_simple", |
|
562d3b219876
mod_csi_muc_priorities: Add an example
Kim Alvefur <zash@zash.se>
parents:
3638
diff
changeset
|
31 "csi_muc_priorities", |
|
562d3b219876
mod_csi_muc_priorities: Add an example
Kim Alvefur <zash@zash.se>
parents:
3638
diff
changeset
|
32 "track_muc_joins", -- optional |
|
562d3b219876
mod_csi_muc_priorities: Add an example
Kim Alvefur <zash@zash.se>
parents:
3638
diff
changeset
|
33 } |
|
562d3b219876
mod_csi_muc_priorities: Add an example
Kim Alvefur <zash@zash.se>
parents:
3638
diff
changeset
|
34 ``` |
