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

Review comments round deux

Browse source
This commit is contained in:
Kegan Dougal 2015-10-15 10:37:15 +01:00
parent 173d00cea0
commit 507cb29e39
1 changed files with 16 additions and 12 deletions
Download patch file Download diff file Expand all files Collapse all files

28
specification/modules/history_visibility.rst
View file

@ -4,21 +4,25 @@ Room History Visibility
.. _module:history-visibility: .. _module:history-visibility:
This module adds support for controlling the visibility of previous events in a This module adds support for controlling the visibility of previous events in a
room. Whether a member of a room can see the events that happened in a room from room.
before they joined the room is controlled by the ``m.room.history_visibility``
event outlined below. In all cases, the member still needs to be joined to the
room to receive events for that room. The visibility option simply determines
which subset of events in the room are presented to the client. Visibility can
take the form of one of three options:
- ``shared`` - Previous events are always shown to newly joined members. All In all cases, a user needs to join a room to view events in that room. Once they
events in the room are shown, even those sent when the member was not a part have joined a room, they will gain access to a subset of events in the room. How
this subset is chosen is controlled by the ``m.room.history_visibility`` event
outlined below. After a user has left a room, they may seen any events which they
were allowed to see before they left the room, but no events received after they
left.
The three options for this event are:
- ``shared`` - Previous events are always accessible to newly joined members. All
events in the room are accessible, even those sent when the member was not a part
of the room. of the room.
- ``invited`` - Previous events are shown to newly joined members from the point - ``invited`` - Previous events are accessible to newly joined members from the point
they were invited onwards. Events stop being shown when the member's state they were invited onwards. Events stop being accessible when the member's state
changes to something other than ``invite`` or ``join``. changes to something other than ``invite`` or ``join``.
- ``joined`` - Previous events are shown to newly joined members from the point - ``joined`` - Previous events are accessible to newly joined members from the point
they joined the room onwards. Events stop being shown when the members state they joined the room onwards. Events stop being accessible when the members state
changes to something other than ``join``. changes to something other than ``join``.
.. WARNING:: .. WARNING::