mirror of
https://github.com/matrix-org/matrix-spec
synced 2025-12-23 17:48:37 +01:00
b07fe504ed
This is actually doing two things:
* creating `{fragments,modules}/index.md` turns the fragments and modules into
page resources, rather than pages in their own right. We have to update the
shortcodes to match.
* adding `headless: true` means that we don't render the pages.
The net effect is that we don't render pages like
https://spec.matrix.org/v1.4/rooms/fragments/v1-auth-rules/ and
https://spec.matrix.org/v1.4/client-server-api/modules/account_data/.
39 lines
1.5 KiB
Markdown
39 lines
1.5 KiB
Markdown
|
|
### Room Previews
|
|
|
|
It is sometimes desirable to offer a preview of a room, where a user can
|
|
"lurk" and read messages posted to the room, without joining the room.
|
|
This can be particularly effective when combined with [Guest Access](#guest-access).
|
|
|
|
Previews are implemented via the `world_readable` [Room History
|
|
Visibility](#room-history-visibility). setting, along with a special version of the [GET
|
|
/events](#get_matrixclientv3events) endpoint.
|
|
|
|
#### Client behaviour
|
|
|
|
A client wishing to view a room without joining it should call [GET
|
|
/rooms/:room\_id/initialSync](#get_matrixclientv3roomsroomidinitialsync),
|
|
followed by [GET /events](#get_matrixclientv3events). Clients will need to do
|
|
this in parallel for each room they wish to view.
|
|
|
|
Clients can of course also call other endpoints such as [GET
|
|
/rooms/:room\_id/messages](#get_matrixclientv3roomsroomidmessages)
|
|
and [GET /search](#post_matrixclientv3search) to
|
|
access events outside the `/events` stream.
|
|
|
|
{{% http-api spec="client-server" api="peeking_events" %}}
|
|
|
|
#### Server behaviour
|
|
|
|
For clients which have not joined a room, servers are required to only
|
|
return events where the room state at the event had the
|
|
`m.room.history_visibility` state event present with
|
|
`history_visibility` value `world_readable`.
|
|
|
|
#### Security considerations
|
|
|
|
Clients may wish to display to their users that rooms which are
|
|
`world_readable` *may* be showing messages to non-joined users. There is
|
|
no way using this module to find out whether any non-joined guest users
|
|
*do* see events in the room, or to list or count any lurking users.
|