File

mod_pubsub_text_interface/README.markdown @ 3291:4c3230c22c18

mod_register_json: Update README
author Matthew Wild <mwild1@gmail.com>
date Wed, 29 Aug 2018 21:57:59 +0100
parent 3244:2b888a7aa21c
child 3410:a0e0ec729aab
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