matrix-spec/specification/modules/history_visibility.rst

Room History Visibility
-----------------------

.. _module:history-visibility:

Whether a member of a room can see the events that happened in a room from
before they joined the room is controlled by the ``history_visibility`` key
of the ``m.room.history_visibility`` state event. The valid values for
``history_visibility`` are:

- ``shared``
- ``invited``
- ``joined``

By default if no ``history_visibility`` is set it is assumed to be ``shared``.

The rules governing whether a user is allowed to see an event depend solely on
the state of the room at that event:

1. If the user was joined, allow.
2. If the user was invited and the ``history_visibility`` was set to
   ``invited`` or ``shared``, allow.
3. If the user was neither invited nor joined but the ``history_visibility``
   was set to ``shared``, allow.
4. Otherwise, deny.
Document m.room.history_visibility 2015-09-01 12:53:30 +02:00			`Room History Visibility`
Modify and enforce the file format/structure used Convert the file format to be of the form ##_##_something.rst where the first ## is the top-level section number and the second ## is the second-level section number, e.g. 07_01_push_cs_api.rst means Section 7.1 - This is now enforced in gendoc.py along with the title line style that should be used (= for top-level, - for 2nd level) which will give helpful suggestions if you trip up. This feels much more intuitive now looking in /specification 2015-09-18 12:43:53 +02:00			`-----------------------`
Document m.room.history_visibility 2015-09-01 12:53:30 +02:00
Add room history visibility as a module. 2015-09-29 17:33:34 +02:00			`.. _module:history-visibility:`

Make it clearer 2015-09-04 12:21:14 +02:00			`Whether a member of a room can see the events that happened in a room from`
			before they joined the room is controlled by the ``history_visibility`` key
			of the ``m.room.history_visibility`` state event. The valid values for
			``history_visibility`` are:
Document m.room.history_visibility 2015-09-01 12:53:30 +02:00
			- ``shared``
			- ``invited``
			- ``joined``

Make it clearer 2015-09-04 12:21:14 +02:00			By default if no ``history_visibility`` is set it is assumed to be ``shared``.
Document m.room.history_visibility 2015-09-01 12:53:30 +02:00
			`The rules governing whether a user is allowed to see an event depend solely on`
Make it clearer 2015-09-04 12:21:14 +02:00			`the state of the room at that event:`
Document m.room.history_visibility 2015-09-01 12:53:30 +02:00
			`1. If the user was joined, allow.`
			2. If the user was invited and the ``history_visibility`` was set to
			``invited`` or ``shared``, allow.
			3. If the user was neither invited nor joined but the ``history_visibility``
			was set to ``shared``, allow.
			`4. Otherwise, deny.`