Clarify guest /events and /sync
This commit is contained in:
parent
3dc7eb23fa
commit
7d9547274c
2 changed files with 9 additions and 0 deletions
|
@ -28,6 +28,10 @@ paths:
|
||||||
|
|
||||||
This API is the same as the non-guest /events endpoint, but can be
|
This API is the same as the non-guest /events endpoint, but can be
|
||||||
called by guest users.
|
called by guest users.
|
||||||
|
|
||||||
|
Note that the non-guest ``/guests`` endpoint has been deprecated. This
|
||||||
|
API will also be deprecated at some point, but its replacement is not
|
||||||
|
yet known.
|
||||||
security:
|
security:
|
||||||
- accessToken: []
|
- accessToken: []
|
||||||
parameters:
|
parameters:
|
||||||
|
|
|
@ -59,6 +59,11 @@ They will only return events which happened while the room state had the
|
||||||
value ``world_readable``. Guest clients do not need to join rooms in order to
|
value ``world_readable``. Guest clients do not need to join rooms in order to
|
||||||
receive events for them.
|
receive events for them.
|
||||||
|
|
||||||
|
The intention is that guest users will call ``/events`` once per room in
|
||||||
|
parallel for rooms they wish to view without joining. For rooms they wish to
|
||||||
|
join, they will call ``/join`` and receive events by calling ``/sync`` as
|
||||||
|
non-guest users do.
|
||||||
|
|
||||||
Server behaviour
|
Server behaviour
|
||||||
----------------
|
----------------
|
||||||
Servers are required to only return events to guest accounts for rooms where
|
Servers are required to only return events to guest accounts for rooms where
|
||||||
|
|
Loading…
Add table
Add a link
Reference in a new issue