summary refs log tree commit diff
path: root/docs/client-server/specification.rst
diff options
context:
space:
mode:
authorDavid Baker <dbkr@matrix.org>2014-09-01 17:55:29 +0100
committerDavid Baker <dbkr@matrix.org>2014-09-01 17:55:41 +0100
commit6d07a28a296e08467216280c24768e55756782c2 (patch)
tree212300dd74bfd6236855ee0b38221a8547a5f859 /docs/client-server/specification.rst
parentAdded roomName, a directive to compute a room name based on its alias (not al... (diff)
downloadsynapse-6d07a28a296e08467216280c24768e55756782c2.tar.xz
fix lying docs
Diffstat (limited to 'docs/client-server/specification.rst')
-rw-r--r--docs/client-server/specification.rst17
1 files changed, 3 insertions, 14 deletions
diff --git a/docs/client-server/specification.rst b/docs/client-server/specification.rst
index 4c9e313a6a..2f6645ceb9 100644
--- a/docs/client-server/specification.rst
+++ b/docs/client-server/specification.rst
@@ -1007,26 +1007,15 @@ for users from other servers entirely.
 Presence
 ========
 
-In the following messages, the presence state is an integer enumeration of the
-following states:
-  0 : OFFLINE
-  1 : BUSY
-  2 : ONLINE
-  3 : FREE_TO_CHAT
-
-Aside from OFFLINE, the protocol doesn't assign any special meaning to these
-states; they are provided as an approximate signal for users to give to other
-users and for clients to present them in some way that may be useful. Clients
-could have different behaviours for different states of the user's presence, for
-example to decide how much prominence or sound to use for incoming event
-notifications.
+In the following messages, the presence state is a presence string as described in
+the main specification document.
 
 Getting/Setting your own presence state
 ---------------------------------------
   REST Path: /presence/$user_id/status
   Valid methods: GET/PUT
   Required keys:
-    presence : [0|1|2|3] - The user's new presence state
+    presence : <string> - The user's new presence state
   Optional keys:
     status_msg : text string provided by the user to explain their status