summary refs log tree commit diff
path: root/docs
diff options
context:
space:
mode:
authorPaul "LeoNerd" Evans <paul@matrix.org>2014-09-01 14:45:35 +0100
committerPaul "LeoNerd" Evans <paul@matrix.org>2014-09-01 14:45:41 +0100
commit02f4e3b3ff613a6e9024c0fef416be0bf92bf48f (patch)
treed3f165d0a69df79b10851a82d87f2615b183f196 /docs
parentFleshed out joining/leaving rooms. Added M_LIMIT_EXCEEDED standard error code... (diff)
downloadsynapse-02f4e3b3ff613a6e9024c0fef416be0bf92bf48f.tar.xz
Rename 'state' presence key to the much more obvious 'presence'; maintain a legacy 'state' copy for now
Diffstat (limited to 'docs')
-rw-r--r--docs/client-server/specification.rst4
-rw-r--r--docs/specification.rst14
2 files changed, 9 insertions, 9 deletions
diff --git a/docs/client-server/specification.rst b/docs/client-server/specification.rst
index ee8bb5c420..4c9e313a6a 100644
--- a/docs/client-server/specification.rst
+++ b/docs/client-server/specification.rst
@@ -1026,7 +1026,7 @@ Getting/Setting your own presence state
   REST Path: /presence/$user_id/status
   Valid methods: GET/PUT
   Required keys:
-    state : [0|1|2|3] - The user's new presence state
+    presence : [0|1|2|3] - The user's new presence state
   Optional keys:
     status_msg : text string provided by the user to explain their status
 
@@ -1039,7 +1039,7 @@ Fetching your presence list
     following keys:
       {
         "user_id" : string giving the observed user's ID
-        "state" : int giving their status
+        "presence" : int giving their status
         "status_msg" : optional text string
         "displayname" : optional text string from the user's profile
         "avatar_url" : optional text string from the user's profile
diff --git a/docs/specification.rst b/docs/specification.rst
index b61994ff35..d47705ca0f 100644
--- a/docs/specification.rst
+++ b/docs/specification.rst
@@ -542,7 +542,7 @@ Each user has the concept of presence information. This encodes the
 "availability" of that user, suitable for display on other user's clients. This
 is transmitted as an ``m.presence`` event and is one of the few events which
 are sent *outside the context of a room*. The basic piece of presence information 
-is represented by the ``state`` key, which is an enum of one of the following:
+is represented by the ``presence`` key, which is an enum of one of the following:
 
   - ``online`` : The default state when the user is connected to an event stream.
   - ``unavailable`` : The user is not reachable at this time.
@@ -552,18 +552,18 @@ is represented by the ``state`` key, which is an enum of one of the following:
   - ``hidden`` : TODO. Behaves as offline, but allows the user to see the client 
     state anyway and generally interact with client features.
 
-This basic ``state`` field applies to the user as a whole, regardless of how many
+This basic ``presence`` field applies to the user as a whole, regardless of how many
 client devices they have connected. The home server should synchronise this
 status choice among multiple devices to ensure the user gets a consistent
 experience.
 
 Idle Time
 ---------
-As well as the basic ``state`` field, the presence information can also show a sense
-of an "idle timer". This should be maintained individually by the user's
-clients, and the home server can take the highest reported time as that to
-report. When a user is offline, the home server can still report when the user was last
-seen online.
+As well as the basic ``presence`` field, the presence information can also show
+a sense of an "idle timer". This should be maintained individually by the
+user's clients, and the home server can take the highest reported time as that
+to report. When a user is offline, the home server can still report when the
+user was last seen online.
 
 Transmission
 ------------