Filip/matrix-spec
1
0
Fork 0
mirror of https://github.com/matrix-org/matrix-spec synced 2025-12-21 00:48:38 +01:00
Code Issues Actions 3 Packages Projects Releases Wiki Activity

clarify world_readable history visibility (#2204)

Browse source 
Signed-off-by: HarHarLinks <2803622+HarHarLinks@users.noreply.github.com>
This commit is contained in:
Kim Brose 2025-09-09 15:02:51 +00:00 committed by GitHub
parent d1a51f7b8c
commit bfbeb5e257
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
4 changed files with 6 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

1
changelogs/client_server/newsfragments/2204.clarification Normal file
View file

@ -0,0 +1 @@
Clarify wording around the `world_readable` history visibility setting. Contributed by @HarHarLinks.

6
content/client-server-api/modules/history_visibility.md
View file

@ -16,8 +16,8 @@ The four options for the `m.room.history_visibility` event are:
- `world_readable` - All events while this is the - `world_readable` - All events while this is the
`m.room.history_visibility` value may be shared by any participating `m.room.history_visibility` value may be shared by any participating
homeserver with anyone, regardless of whether they have ever joined homeserver with any authenticated user, regardless of whether they have
the room. ever joined the room. This includes [guest users](#guest-access).
- `shared` - Previous events are always accessible to newly joined - `shared` - Previous events are always accessible to newly joined
members. All events in the room are accessible, even those sent when members. All events in the room are accessible, even those sent when
the member was not a part of the room. the member was not a part of the room.
@ -44,7 +44,7 @@ setting at that time was more restrictive.
#### Client behaviour #### Client behaviour
Clients may want to display a notice that events may be read by Clients may want to display a notice that events may be read by
non-joined people if the history visibility is set to `world_readable`. non-joined users if the history visibility is set to `world_readable`.
#### Server behaviour #### Server behaviour

2
content/client-server-api/modules/room_previews.md
View file

@ -6,7 +6,7 @@ It is sometimes desirable to offer a preview of a room, where a user can
This can be particularly effective when combined with [Guest Access](#guest-access). This can be particularly effective when combined with [Guest Access](#guest-access).
Previews are implemented via the `world_readable` [Room History Previews are implemented via the `world_readable` [Room History
Visibility](#room-history-visibility). setting, along with a special version of the [GET Visibility](#room-history-visibility) setting, along with a special version of the [GET
/events](#get_matrixclientv3events) endpoint. /events](#get_matrixclientv3events) endpoint.
#### Client behaviour #### Client behaviour

2
data/api/client-server/definitions/public_rooms_chunk.yaml
View file

@ -43,7 +43,7 @@ properties:
example: "All things general" example: "All things general"
world_readable: world_readable:
type: boolean type: boolean
description: Whether the room may be viewed by guest users without joining. description: Whether the room may be viewed by users without joining.
example: false example: false
guest_can_join: guest_can_join:
type: boolean type: boolean