File

mod_compat_roles/README.md @ 6119:6dca425eea15

mod_pubsub_subscription: Don't block pubsub unhandled or bare JID notifications The module was marking every successfully-parsed pubsub notification as handled, which could prevent local users from receiving pubsub notifications. Now it will only eat them if both: - The notification was sent to the host JID - The notification matched a node we consider ourselves subscribed to Notifications to local (i.e. non-host) JIDs will always be let through.
author Matthew Wild <mwild1@gmail.com>
date Sat, 28 Dec 2024 18:45:40 +0000
parent 6003:fe081789f7b5
line wrap: on
line source

---
labels:
- Stage-Alpha
summary: Compatibility layer for Prosody's future roles API
---

Introduction
============

This module provides compatibility with Prosody's new role and permissions
system. It aims to run on Prosody 0.11 and 0.12, providing a limited version
of the new API backed by is_admin() (which is not going to be present in trunk
and future Prosody versions).

It is designed for use by modules which want to be compatible with Prosody
versions with and without the new permissions API.

Configuration
=============

There is no configuration.

Usage (for developers)
======================

If you are a module developer, and want your module to work with Prosody trunk
and future releases, you should avoid the `usermanager.is_admin()` function.

Instead, depend on this module:

```
module:depends("compat_roles")
```

Then use `module:may()` instead:

```
if module:may(":do-something") then
  -- Blah
end
```

For more information on the new role/permissions API, check Prosody's
developer documentation at https://prosody.im/doc/developers/permissions

Compatibility
=============

Requires Prosody 0.11 or 0.12.