summary refs log tree commit diff
path: root/docs
diff options
context:
space:
mode:
authorErik Johnston <erik@matrix.org>2014-09-05 22:01:10 +0100
committerErik Johnston <erik@matrix.org>2014-09-05 22:01:10 +0100
commitfc65b68f3095f446d00ac4c6bae106883b3f5eb9 (patch)
tree8da08b6ebc17f89016876f7ffe96a4abb996364b /docs
parentValidate power levels event changes. Change error messages to be more helpful... (diff)
downloadsynapse-fc65b68f3095f446d00ac4c6bae106883b3f5eb9.tar.xz
Add m.roo.aliases
Diffstat (limited to 'docs')
-rw-r--r--docs/specification.rst16
1 files changed, 16 insertions, 0 deletions
diff --git a/docs/specification.rst b/docs/specification.rst
index 1d3c283331..6776579d33 100644
--- a/docs/specification.rst
+++ b/docs/specification.rst
@@ -909,6 +909,22 @@ prefixed with ``m.``
     ``ban_level`` will be greater than or equal to ``kick_level`` since 
     banning is more severe than kicking.
 
+``m.room.aliases``
+  Summary:
+    These state events are used to inform the room about what room aliases it has.
+  Type:
+    State event
+  JSON format:
+    ``{ "aliases": ["string", ...] }``
+  Example:
+    ``{ "aliases": ["#foo:example.com"] }``
+  Description:
+    A server `may` inform the room that it has added or removed an alias for 
+    the room. This is purely for informational purposes and may become stale.
+    Clients `should` check that the room alias is still valid before using it.
+    The ``state_key`` of the event is the homeserver which owns the room 
+    alias.
+
 ``m.room.message``
   Summary:
     A message.