summary refs log tree commit diff
path: root/docs/specification.rst
diff options
context:
space:
mode:
authorDavid Baker <dbkr@matrix.org>2014-09-16 14:54:52 +0100
committerDavid Baker <dbkr@matrix.org>2014-09-16 14:54:52 +0100
commitf4094c5eb33884050a7de2a4de233673ea4a2af7 (patch)
treea92922f6e541914f833e356c4c7bedb9cb946e02 /docs/specification.rst
parentUse event age to recognise which calls are current and which aren't and hence... (diff)
downloadsynapse-f4094c5eb33884050a7de2a4de233673ea4a2af7.tar.xz
Update spec with the lifetime field.
Diffstat (limited to '')
-rw-r--r--docs/specification.rst10
1 files changed, 8 insertions, 2 deletions
diff --git a/docs/specification.rst b/docs/specification.rst
index a2e348fa2b..370e238e00 100644
--- a/docs/specification.rst
+++ b/docs/specification.rst
@@ -1169,8 +1169,14 @@ This event is sent by the caller when they wish to establish a call.
   Required keys:
     - ``call_id`` : "string" - A unique identifier for the call
     - ``offer`` : "offer object" - The session description
-    - ``version`` : "integer" - The version of the VoIP specification this message
-                                adheres to. This specification is version 0.
+    - ``version`` : "integer" - The version of the VoIP specification this
+                                message adheres to. This specification is
+                                version 0.
+    - ``lifetime`` : "integer" - The time in milliseconds that the invite is
+                                 valid for. Once the invite age exceeds this
+                                 value, clients should discard it. They
+                                 should also no longer show the call as
+                                 awaiting an answer in the UI.
       
   Optional keys:
     None.