view mod_csi_simple_compat/README.markdown @ 4983:7c77058a1ac5

mod_compat_roles: New module providing compat shim for trunk's new role API The new role API is translated to is_admin() calls on older versions. On newer versions (which have the role API) this module does nothing. It allows modules to drop their use of is_admin() (which is not available in trunk) and switch to the new role API, while remaining compatible with previous Prosody versions.
author Matthew Wild <mwild1@gmail.com>
date Thu, 11 Aug 2022 17:49:33 +0100
parents fcea7cf91702
children
line wrap: on
line source

# About

This module allows using the [mod_csi_simple][doc:modules:mod_csi_simple]
setting `csi_important_payloads` (added in trunk/0.12) in Prosody 0.11.x.

# Config

```
modules_enabled = {
    -- other modules etc
    "csi_simple",
    "csi_simple_compat",
}

csi_important_payloads = {
    -- Anything in this namespace:
    "{urn:example:important-namespace}",
    -- Specific element name and namespace:
    "{urn:example:xmpp:priority}super-important",
}
```

# Example

``` lua
csi_important_payloads = {
    -- XEP-0353: Jingle Message Initiation
    "{urn:xmpp:jingle-message:0}",
}
```