prosody-modules
c887820cd884
mod_filter_chatstates/README.md

Find changesets by keywords by author, files, the commit message, revision number or hash, or revset expression.

Software / code / prosody-modules

Annotate

mod_filter_chatstates/README.md @ 6185:c887820cd884

Check both localpart and host In case sending a message to someone with same username as you
author Stephen Paul Weber <singpolyma@singpolyma.net>
date Mon, 03 Feb 2025 17:04:23 -0500
parent 6086:b6c17530a8fb
child 6211:750d64c47ec6
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
1803
4d73a1a6ba68 Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents: 1782
diff changeset
1 ---
4d73a1a6ba68 Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents: 1782
diff changeset
2 summary: Drop chat states from messages to inactive sessions
4d73a1a6ba68 Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents: 1782
diff changeset
3 ...
1782
29f3d6b7ad16 Import wiki pages
Kim Alvefur <zash@zash.se>
parents:
diff changeset
4
6086
b6c17530a8fb mod_filter_chatstates: Add note about csi_simple
Menel <menel@snikket.de>
parents: 6003
diff changeset
5 ::: {.alert .alert-info}
b6c17530a8fb mod_filter_chatstates: Add note about csi_simple
Menel <menel@snikket.de>
parents: 6003
diff changeset
6 This module discards certain kinds of stanzas that are unnecessary to deliver to inactive clients. This is technically against the XMPP specification, and has the potential to cause bugs. However it is being used by some people successfully, and reduces the overall bandwidth usage for mobile devices.
b6c17530a8fb mod_filter_chatstates: Add note about csi_simple
Menel <menel@snikket.de>
parents: 6003
diff changeset
7 On the other hand it does not save battery usage in a relevant way compared to other `csi` modules.
b6c17530a8fb mod_filter_chatstates: Add note about csi_simple
Menel <menel@snikket.de>
parents: 6003
diff changeset
8 Consider using [mod_csi_simple][doc:modules:mod_csi_simple] that is incuded in prosody since Version 0.11.
b6c17530a8fb mod_filter_chatstates: Add note about csi_simple
Menel <menel@snikket.de>
parents: 6003
diff changeset
9 :::
b6c17530a8fb mod_filter_chatstates: Add note about csi_simple
Menel <menel@snikket.de>
parents: 6003
diff changeset
10
1803
4d73a1a6ba68 Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents: 1782
diff changeset
11 Introduction
4d73a1a6ba68 Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents: 1782
diff changeset
12 ============
1782
29f3d6b7ad16 Import wiki pages
Kim Alvefur <zash@zash.se>
parents:
diff changeset
13
1803
4d73a1a6ba68 Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents: 1782
diff changeset
14 Some mobile XMPP client developers consider [Chat State
4d73a1a6ba68 Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents: 1782
diff changeset
15 Notifications](http://xmpp.org/extensions/xep-0085.html) to be a waste
4d73a1a6ba68 Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents: 1782
diff changeset
16 of power and bandwidth, especially when the user is not actively looking
4d73a1a6ba68 Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents: 1782
diff changeset
17 at their device. This module will filter them out while the session is
1873
9283a6bcf512 mod_filter_chatstates: Link to mod_csi
Kim Alvefur <zash@zash.se>
parents: 1803
diff changeset
18 considered inactive. It depends on [mod\_csi](/mod_csi.html) for
9283a6bcf512 mod_filter_chatstates: Link to mod_csi
Kim Alvefur <zash@zash.se>
parents: 1803
diff changeset
19 deciding when to begin and end filtering.
1803
4d73a1a6ba68 Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents: 1782
diff changeset
20
4d73a1a6ba68 Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents: 1782
diff changeset
21 Configuration
4d73a1a6ba68 Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents: 1782
diff changeset
22 =============
1782
29f3d6b7ad16 Import wiki pages
Kim Alvefur <zash@zash.se>
parents:
diff changeset
23
1803
4d73a1a6ba68 Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents: 1782
diff changeset
24 There is no configuration for this module, just add it to
4d73a1a6ba68 Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents: 1782
diff changeset
25 modules\_enabled as normal.
1782
29f3d6b7ad16 Import wiki pages
Kim Alvefur <zash@zash.se>
parents:
diff changeset
26
1803
4d73a1a6ba68 Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents: 1782
diff changeset
27 Compatibility
4d73a1a6ba68 Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents: 1782
diff changeset
28 =============
1782
29f3d6b7ad16 Import wiki pages
Kim Alvefur <zash@zash.se>
parents:
diff changeset
29
1803
4d73a1a6ba68 Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents: 1782
diff changeset
30 ----- -------
6086
b6c17530a8fb mod_filter_chatstates: Add note about csi_simple
Menel <menel@snikket.de>
parents: 6003
diff changeset
31 0.11 Works
b6c17530a8fb mod_filter_chatstates: Add note about csi_simple
Menel <menel@snikket.de>
parents: 6003
diff changeset
32 0.10 Works
1803
4d73a1a6ba68 Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents: 1782
diff changeset
33 ----- -------