tileradotorg/synapse
1
0
Fork 0
forked from MirrorHub/synapse
Code Pull requests Activity

fix lying docs

Browse source
This commit is contained in:
David Baker 2014-09-01 17:55:29 +01:00
parent 7d99cee3ef
commit 6d07a28a29
1 changed files with 3 additions and 14 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

17
docs/client-server/specification.rst
View file

@ -1007,26 +1007,15 @@ for users from other servers entirely.
Presence Presence
======== ========
In the following messages, the presence state is an integer enumeration of the In the following messages, the presence state is a presence string as described in
following states: the main specification document.
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.
Getting/Setting your own presence state Getting/Setting your own presence state
--------------------------------------- ---------------------------------------
REST Path: /presence/$user_id/status REST Path: /presence/$user_id/status
Valid methods: GET/PUT Valid methods: GET/PUT
Required keys: Required keys:
presence : [0|1|2|3] - The user's new presence state presence : <string> - The user's new presence state
Optional keys: Optional keys:
status_msg : text string provided by the user to explain their status status_msg : text string provided by the user to explain their status