diff options
author | Krombel <krombel@krombel.de> | 2018-03-28 14:45:28 +0200 |
---|---|---|
committer | Krombel <krombel@krombel.de> | 2018-03-28 14:45:28 +0200 |
commit | 6152e253d842eb4f72be975850450f00c0662e43 (patch) | |
tree | 5fa7c6cef720825e05076190c7d0e1f45565a4b5 /docs/admin_api | |
parent | move handling of auto_join_rooms to RegisterHandler (diff) | |
parent | Merge pull request #3042 from matrix-org/fix_locally_failing_tests (diff) | |
download | synapse-6152e253d842eb4f72be975850450f00c0662e43.tar.xz |
Merge branch 'develop' of into allow_auto_join_rooms
Diffstat (limited to 'docs/admin_api')
-rw-r--r-- | docs/admin_api/purge_history_api.rst | 6 |
1 files changed, 4 insertions, 2 deletions
diff --git a/docs/admin_api/purge_history_api.rst b/docs/admin_api/purge_history_api.rst index ea2922da5c..2da833c827 100644 --- a/docs/admin_api/purge_history_api.rst +++ b/docs/admin_api/purge_history_api.rst @@ -16,9 +16,11 @@ including an ``access_token`` of a server admin. By default, events sent by local users are not deleted, as they may represent the only copies of this content in existence. (Events sent by remote users are -deleted, and room state data before the cutoff is always removed). +deleted.) -To delete local events as well, set ``delete_local_events`` in the body: +Room state data (such as joins, leaves, topic) is always preserved. + +To delete local message events as well, set ``delete_local_events`` in the body: .. code:: json |