Mercurial > prosody-modules

annotate mod_pubsub_text_interface/README.markdown @ 5218:1f4b768c831a

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
mod_http_oauth2: Correct field name for HTTP response status code 'code' is used in the incoming side of the Prosody HTTP stack while 'status_code' is used on the response side. Not confusing at all. The default is 200 so this mistake had no real effect.
author Kim Alvefur <zash@zash.se>
date Tue, 07 Mar 2023 13:14:25 +0100
parents 12c7c0d7e1b0
children
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
3410
a0e0ec729aab mod_pubsub_text_interface/README: Normalize Markdown syntax
Kim Alvefur <zash@zash.se>
parents: 3244
diff changeset
5 `include_body` flag is enabled so that a plain text body version of
a0e0ec729aab mod_pubsub_text_interface/README: Normalize Markdown syntax
Kim Alvefur <zash@zash.se>
parents: 3244
diff changeset
6 events can be included, where supported.
3244
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
3410
a0e0ec729aab mod_pubsub_text_interface/README: Normalize Markdown syntax
Kim Alvefur <zash@zash.se>
parents: 3244
diff changeset
10 ``` {.lua}
3436
12c7c0d7e1b0 mod_pubsub_text_interface/README: Fix typo (thanks perflyst)
Kim Alvefur <zash@zash.se>
parents: 3413
diff changeset
11 Component "pubsub.example.com" "pubsub"
3244
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
3410
a0e0ec729aab mod_pubsub_text_interface/README: Normalize Markdown syntax
Kim Alvefur <zash@zash.se>
parents: 3244
diff changeset
24 - `help` - a help message, listing these commands
a0e0ec729aab mod_pubsub_text_interface/README: Normalize Markdown syntax
Kim Alvefur <zash@zash.se>
parents: 3244
diff changeset
25 - `list` - list available nodes
a0e0ec729aab mod_pubsub_text_interface/README: Normalize Markdown syntax
Kim Alvefur <zash@zash.se>
parents: 3244
diff changeset
26 - `subscribe node` - subscribe to a node
a0e0ec729aab mod_pubsub_text_interface/README: Normalize Markdown syntax
Kim Alvefur <zash@zash.se>
parents: 3244
diff changeset
27 - `unsubscribe node` - unsubscribe from a node
3411
c479e39ff547 mod_pubsub_text_interface/README: Document the 'last' command
Kim Alvefur <zash@zash.se>
parents: 3410
diff changeset
28 - `last node` - sends the last published item from the node to you
3412
d50d1dfab9eb mod_pubsub_text_interface/README: Add a Compatibility section
Kim Alvefur <zash@zash.se>
parents: 3411
diff changeset
29
d50d1dfab9eb mod_pubsub_text_interface/README: Add a Compatibility section
Kim Alvefur <zash@zash.se>
parents: 3411
diff changeset
30 # Compatibility
d50d1dfab9eb mod_pubsub_text_interface/README: Add a Compatibility section
Kim Alvefur <zash@zash.se>
parents: 3411
diff changeset
31
d50d1dfab9eb mod_pubsub_text_interface/README: Add a Compatibility section
Kim Alvefur <zash@zash.se>
parents: 3411
diff changeset
32 Should work with Prosody since 0.9, when
3413
6421c9f05e02 mod_pubsub_text_interface/README: Add lost _
Kim Alvefur <zash@zash.se>
parents: 3412
diff changeset
33 [mod\_pubsub][doc:modules:mod_pubsub] was introduced.
3412
d50d1dfab9eb mod_pubsub_text_interface/README: Add a Compatibility section
Kim Alvefur <zash@zash.se>
parents: 3411
diff changeset
34
d50d1dfab9eb mod_pubsub_text_interface/README: Add a Compatibility section
Kim Alvefur <zash@zash.se>
parents: 3411
diff changeset
35 The `last` command is available from Prosody 0.11.