wholetrans/docs-matrix-spec
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

some comments on general_api

Browse source
This commit is contained in:
Matthew Hodgson 2015-01-13 13:20:25 +00:00
parent d5099b2656
commit 1c69ba974f
1 changed files with 7 additions and 7 deletions
Download patch file Download diff file Expand all files Collapse all files

14
drafts/general_api.rst
View file

@ -93,9 +93,9 @@ Inputs:
- Whether you want federation-style event JSON - Whether you want federation-style event JSON
- Whether you want coalesced ``updates`` events - Whether you want coalesced ``updates`` events
- Whether you want coalesced ``relates_to`` events (and the max # to coalesce) - Whether you want coalesced ``relates_to`` events (and the max # to coalesce)
- limit= param? - limit= param? (XXX: probably not; this should be done in the query itself)
- Which keys to return for events? e.g. no ``origin_server_ts`` if you don't - Which keys to return for events? e.g. no ``origin_server_ts`` if you don't
show timestamps show timestamps (n.b. encrypted keys can't be filtered out)
Outputs: Outputs:
- An opaque token which represents the inputs, the "filter token". - An opaque token which represents the inputs, the "filter token".
Notes: Notes:
@ -132,8 +132,8 @@ Outputs:
- max of limit= message events - max of limit= message events
- room ID - room ID
Notes: Notes:
- If a chunk token is applied, you will get a delta rather than all the - If a chunk token is applied, you will get a delta relative to the last request
rooms. performed with that streaming token rather than all the rooms.
Compacting notes: Compacting notes:
- Fixes the problem with the same event appearing in both the ``messages`` and - Fixes the problem with the same event appearing in both the ``messages`` and
``state`` keys. Represent as something like:: ``state`` keys. Represent as something like::
@ -151,8 +151,8 @@ Duplicate content notes:
state events will need to specify the ``prev_content``. state events will need to specify the ``prev_content``.
What data flows does it address: What data flows does it address:
- Home screen: data required on load. - Home screen: data required on load.
- XXX: would this also be used for initially loading room history screens too?
Event Stream API ``[Draft]`` Event Stream API ``[Draft]``
---------------------------- ----------------------------
Inputs: Inputs:
@ -408,7 +408,7 @@ Inputs:
- Which keys to retrieve - Which keys to retrieve
Output: Output:
- The key/values specified. - The key/values specified.
Propagation Propagation
~~~~~~~~~~~ ~~~~~~~~~~~
The goals of propagation are: The goals of propagation are: