Mercurial > prosody-modules

annotate mod_pubsub_text_interface/README.markdown @ 3362:af085e8b9d48

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
mod_conversejs: Link to BOSH and WebSockets setup instructions instead of module pages
author Kim Alvefur <zash@zash.se>
date Thu, 25 Oct 2018 22:41:13 +0200
parents 2b888a7aa21c
children a0e0ec729aab
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
3244
2b888a7aa21c mod_pubsub_text_interface: Add a README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
1 # Introduction
2b888a7aa21c mod_pubsub_text_interface: Add a README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
2
2b888a7aa21c mod_pubsub_text_interface: Add a README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
3 This module lets you manage subscriptions to pubsub nodes via simple
2b888a7aa21c mod_pubsub_text_interface: Add a README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
4 chat messages. Subscriptions are always added based on bare JID. The
2b888a7aa21c mod_pubsub_text_interface: Add a README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
5 `include_body` flag is enabled so that a plain text body version of events
2b888a7aa21c mod_pubsub_text_interface: Add a README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
6 can be included, where supported.
2b888a7aa21c mod_pubsub_text_interface: Add a README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
7
2b888a7aa21c mod_pubsub_text_interface: Add a README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
8 # Configuring
2b888a7aa21c mod_pubsub_text_interface: Add a README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
9
2b888a7aa21c mod_pubsub_text_interface: Add a README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
10 ```lua
2b888a7aa21c mod_pubsub_text_interface: Add a README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
11 Component "pubsub.example.com" "pubub"
2b888a7aa21c mod_pubsub_text_interface: Add a README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
12 modules_enabled = {
2b888a7aa21c mod_pubsub_text_interface: Add a README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
13 "pubsub_text_interface",
2b888a7aa21c mod_pubsub_text_interface: Add a README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
14 }
2b888a7aa21c mod_pubsub_text_interface: Add a README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
15 ```
2b888a7aa21c mod_pubsub_text_interface: Add a README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
16
2b888a7aa21c mod_pubsub_text_interface: Add a README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
17 # Commands
2b888a7aa21c mod_pubsub_text_interface: Add a README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
18
2b888a7aa21c mod_pubsub_text_interface: Add a README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
19 The following commands are supported. Simply send a normal chat message
2b888a7aa21c mod_pubsub_text_interface: Add a README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
20 to the PubSub component where this module is enabled. When subscribing
2b888a7aa21c mod_pubsub_text_interface: Add a README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
21 or unsubscribing, be sure to replace `node` with the node you want to
2b888a7aa21c mod_pubsub_text_interface: Add a README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
22 subscribe to or unsubscribe from.
2b888a7aa21c mod_pubsub_text_interface: Add a README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
23
2b888a7aa21c mod_pubsub_text_interface: Add a README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
24 - `help` - a help message, listing these commands
2b888a7aa21c mod_pubsub_text_interface: Add a README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
25 - `list` - list available nodes
2b888a7aa21c mod_pubsub_text_interface: Add a README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
26 - `subscribe node` - subscribe to a node
2b888a7aa21c mod_pubsub_text_interface: Add a README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
27 - `unsubscribe node` - unsubscribe from a node