TODO/notes consistency. Add a few minor points.
This commit is contained in:
parent
9408bc8260
commit
f88527724f
1 changed files with 21 additions and 20 deletions
|
@ -57,8 +57,10 @@ home server path prefixes.
|
||||||
Filter API ``[ONGOING]``
|
Filter API ``[ONGOING]``
|
||||||
------------------------
|
------------------------
|
||||||
.. NOTE::
|
.. NOTE::
|
||||||
Exactly what can be filtered? Which APIs use this? Are we
|
- Exactly what can be filtered? Which APIs use this? Are we
|
||||||
conflating too much?
|
conflating too much?
|
||||||
|
- Do we want to specify negative filters (e.g. don't give me
|
||||||
|
``event.type.here`` events)
|
||||||
|
|
||||||
Inputs:
|
Inputs:
|
||||||
- Which event types (incl wildcards)
|
- Which event types (incl wildcards)
|
||||||
|
@ -81,12 +83,22 @@ Notes:
|
||||||
- HTTP note: If the filter API is a separate endpoint, then you could easily
|
- HTTP note: If the filter API is a separate endpoint, then you could easily
|
||||||
allow APIs which use filtering to ALSO specifiy query parameters to tweak the
|
allow APIs which use filtering to ALSO specifiy query parameters to tweak the
|
||||||
filter.
|
filter.
|
||||||
TODO:
|
|
||||||
- Do we want to specify negative filters (e.g. don't give me
|
|
||||||
``event.type.here`` events)
|
|
||||||
|
|
||||||
Global initial sync API ``[ONGOING]``
|
Global initial sync API ``[ONGOING]``
|
||||||
-------------------------------------
|
-------------------------------------
|
||||||
|
.. NOTE::
|
||||||
|
- Will need some form of state event pagination like we have for message events
|
||||||
|
to handle large amounts of state events for a room. Need to think of the
|
||||||
|
consequences of this: you may not get a ``m.room.member`` for someone's
|
||||||
|
message and so cannot display their display name / avatar. Do we want to
|
||||||
|
provide pagination on an event type basis?
|
||||||
|
- Handle paginating initial sync results themselves (e.g. 10 most recent rooms)
|
||||||
|
- No need for state events under the 'state' key to have a ``prev_content``.
|
||||||
|
Can also apply some optimisations depending on the direction of travel when
|
||||||
|
scrolling back.
|
||||||
|
- Do we want to treat global / specific room initial syncs as separate entities?
|
||||||
|
Aren't they just a filter?
|
||||||
|
|
||||||
Inputs:
|
Inputs:
|
||||||
- A way of identifying the user (e.g. access token, user ID, etc)
|
- A way of identifying the user (e.g. access token, user ID, etc)
|
||||||
- Streaming token (optional)
|
- Streaming token (optional)
|
||||||
|
@ -104,17 +116,6 @@ Notes:
|
||||||
rooms.
|
rooms.
|
||||||
What data flows does it address:
|
What data flows does it address:
|
||||||
- Home screen: data required on load.
|
- Home screen: data required on load.
|
||||||
|
|
||||||
TODO:
|
|
||||||
- Will need some form of state event pagination like we have for message events
|
|
||||||
to handle large amounts of state events for a room. Need to think of the
|
|
||||||
consequences of this: you may not get a ``m.room.member`` for someone's
|
|
||||||
message and so cannot display their display name / avatar. Do we want to
|
|
||||||
provide pagination on an event type basis?
|
|
||||||
- Handle paginating initial sync results themselves (e.g. 10 most recent rooms)
|
|
||||||
- No need for state events under the 'state' key to have a ``prev_content``.
|
|
||||||
Can also apply some optimisations depending on the direction of travel when
|
|
||||||
scrolling back.
|
|
||||||
|
|
||||||
|
|
||||||
Event Stream API ``[Draft]``
|
Event Stream API ``[Draft]``
|
||||||
|
@ -178,8 +179,8 @@ What data flows does it address:
|
||||||
- Chat Screen: Data required when the room name changes
|
- Chat Screen: Data required when the room name changes
|
||||||
- Chat Screen: Data required when a new message arrives
|
- Chat Screen: Data required when a new message arrives
|
||||||
|
|
||||||
Room Creation ``[Draft]``
|
Room Creation API ``[Draft]``
|
||||||
-------------------------
|
-----------------------------
|
||||||
Inputs:
|
Inputs:
|
||||||
- Invitee list of user IDs, public/private, state events to set on creation
|
- Invitee list of user IDs, public/private, state events to set on creation
|
||||||
e.g. name of room, alias of room, topic of room
|
e.g. name of room, alias of room, topic of room
|
||||||
|
@ -190,8 +191,8 @@ Notes:
|
||||||
What data flows does it address:
|
What data flows does it address:
|
||||||
- Home Screen: Creating a room
|
- Home Screen: Creating a room
|
||||||
|
|
||||||
Joining a room ``[Draft]``
|
Joining API``[Draft]``
|
||||||
--------------------------
|
----------------------
|
||||||
Inputs:
|
Inputs:
|
||||||
- Room ID (with list of servers to join from) / room alias / invite event ID
|
- Room ID (with list of servers to join from) / room alias / invite event ID
|
||||||
- Optional filter (which events to return, whether the returned events should
|
- Optional filter (which events to return, whether the returned events should
|
||||||
|
|
Loading…
Add table
Add a link
Reference in a new issue