Software /
code /
prosody-modules
File
mod_pubsub_text_interface/README.markdown @ 3422:ba3c79ef2253
lint: Teach luacheck about the new module:send_iq API
author | Kim Alvefur <zash@zash.se> |
---|---|
date | Wed, 02 Jan 2019 10:49:43 +0100 |
parent | 3413:6421c9f05e02 |
child | 3436:12c7c0d7e1b0 |
line wrap: on
line source
# Introduction This module lets you manage subscriptions to pubsub nodes via simple chat messages. Subscriptions are always added based on bare JID. The `include_body` flag is enabled so that a plain text body version of events can be included, where supported. # Configuring ``` {.lua} Component "pubsub.example.com" "pubub" modules_enabled = { "pubsub_text_interface", } ``` # Commands The following commands are supported. Simply send a normal chat message to the PubSub component where this module is enabled. When subscribing or unsubscribing, be sure to replace `node` with the node you want to subscribe to or unsubscribe from. - `help` - a help message, listing these commands - `list` - list available nodes - `subscribe node` - subscribe to a node - `unsubscribe node` - unsubscribe from a node - `last node` - sends the last published item from the node to you # Compatibility Should work with Prosody since 0.9, when [mod\_pubsub][doc:modules:mod_pubsub] was introduced. The `last` command is available from Prosody 0.11.