mirror of
https://github.com/matrix-org/matrix-spec
synced 2026-01-03 14:38:37 +01:00
Add a module for client config to the specification
This commit is contained in:
parent
22b3159a39
commit
c3769ef75c
26
specification/modules/client_config.rst
Normal file
26
specification/modules/client_config.rst
Normal file
|
|
@ -0,0 +1,26 @@
|
|||
Client Config
|
||||
=============
|
||||
|
||||
.. _module:client_config:
|
||||
|
||||
Clients can store their config on their homeserver. This config will be synced
|
||||
between different devices and can persist across installations on a particular
|
||||
device.
|
||||
|
||||
The config may be either global or scoped to a particular rooms.
|
||||
|
||||
Events
|
||||
------
|
||||
|
||||
The client recieves the config as a event in the ``private_user_data`` sections
|
||||
of a v2 /sync.
|
||||
|
||||
These events can also be received in a v1 /events response or in the
|
||||
``private_user_data`` section of a room in v1 /initialSync. ``m.tag``
|
||||
events appearing in v1 /events will have a ``room_id`` with the room
|
||||
the tags are for.
|
||||
|
||||
Client Behaviour
|
||||
----------------
|
||||
|
||||
{{v2_client_config_http_api}}
|
||||
|
|
@ -26,6 +26,7 @@ groups: # reusable blobs of files when prefixed with 'group:'
|
|||
- modules/third_party_invites.rst
|
||||
- modules/search.rst
|
||||
- modules/tags.rst
|
||||
- modules/client_config.rst
|
||||
|
||||
|
||||
title_styles: ["=", "-", "~", "+", "^", "`"]
|
||||
|
|
|
|||
Loading…
Reference in a new issue