view mod_pubsub_text_interface/README.markdown @ 4211:0f26ae2f2a74

mod_invites_page: Change client selection button text from 'Install' to 'Select' by default This also allows specific clients entries to override the text via the 'select_text' field. Rationale: 1) users may already have the software installed, we still want them to select it anyway for the tailored setup experience. 2) some clients (e.g. web clients) are not really "installed" so the text was misleading
author Matthew Wild <mwild1@gmail.com>
date Fri, 16 Oct 2020 11:06:25 +0100
parents 12c7c0d7e1b0
children
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" "pubsub"
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.