Mercurial > prosody-modules
comparison mod_pubsub_text_interface/README.md @ 5975:fe081789f7b5
All community modules: Unify file extention of Markdown files to .md
| author | Menel <menel@snikket.de> |
|---|---|
| date | Tue, 22 Oct 2024 10:26:01 +0200 |
| parents | mod_pubsub_text_interface/README.markdown@12c7c0d7e1b0 |
| children |
comparison
equal
deleted
inserted
replaced
| 5974:5a65a632d5b9 | 5975:fe081789f7b5 |
|---|---|
| 1 # Introduction | |
| 2 | |
| 3 This module lets you manage subscriptions to pubsub nodes via simple | |
| 4 chat messages. Subscriptions are always added based on bare JID. The | |
| 5 `include_body` flag is enabled so that a plain text body version of | |
| 6 events can be included, where supported. | |
| 7 | |
| 8 # Configuring | |
| 9 | |
| 10 ``` {.lua} | |
| 11 Component "pubsub.example.com" "pubsub" | |
| 12 modules_enabled = { | |
| 13 "pubsub_text_interface", | |
| 14 } | |
| 15 ``` | |
| 16 | |
| 17 # Commands | |
| 18 | |
| 19 The following commands are supported. Simply send a normal chat message | |
| 20 to the PubSub component where this module is enabled. When subscribing | |
| 21 or unsubscribing, be sure to replace `node` with the node you want to | |
| 22 subscribe to or unsubscribe from. | |
| 23 | |
| 24 - `help` - a help message, listing these commands | |
| 25 - `list` - list available nodes | |
| 26 - `subscribe node` - subscribe to a node | |
| 27 - `unsubscribe node` - unsubscribe from a node | |
| 28 - `last node` - sends the last published item from the node to you | |
| 29 | |
| 30 # Compatibility | |
| 31 | |
| 32 Should work with Prosody since 0.9, when | |
| 33 [mod\_pubsub][doc:modules:mod_pubsub] was introduced. | |
| 34 | |
| 35 The `last` command is available from Prosody 0.11. |