Mercurial > prosody-modules
diff mod_rest/README.markdown @ 3827:7d909976ca88
mod_rest: Describe kind and type fields
author | Kim Alvefur <zash@zash.se> |
---|---|
date | Thu, 02 Jan 2020 10:45:14 +0100 |
parents | 21ffca4d3aae |
children | a8aa11cc351d |
line wrap: on
line diff
--- a/mod_rest/README.markdown Thu Jan 02 10:08:48 2020 +0100 +++ b/mod_rest/README.markdown Thu Jan 02 10:45:14 2020 +0100 @@ -150,6 +150,14 @@ #### Messages +`kind` +: `"message"` + +`type` +: Commonly `"chat"` for 1-to-1 messages and `"groupchat"` for group + chat messages. Others include `"normal"`, `"headline"` and + `"error"`. + `body` : Human-readable message text. @@ -164,6 +172,12 @@ #### Presence +`kind` +: `"presence"` + +`type` +: Empty for online or `"unavailable"` for offline. + `show` : [Online status](https://xmpp.org/rfcs/rfc6121.html#presence-syntax-children-show), @@ -179,6 +193,13 @@ Only one type of payload can be included in an `iq`. +`kind` +: `"iq"` + +`type` +: `"get"` or `"set"` for queries, `"response"` or `"error"` for + replies. + `ping` : Send a ping. Get a pong. Maybe.