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

Merge branch 'markjh/room_tags' into markjh/client_config

Browse source 
Conflicts:
	api/client-server/v1/rooms.yaml
	api/client-server/v1/sync.yaml
	api/client-server/v2_alpha/sync.yaml
	specification/targets.yaml
This commit is contained in:
Mark Haines 2015-11-18 15:30:16 +00:00
commit 24c4b8b095
5 changed files with 30 additions and 11 deletions
Download patch file Download diff file Expand all files Collapse all files

23
specification/modules/tags.rst
View file

@ -11,16 +11,35 @@ Events
------
The tags on a room are received as single ``m.tag`` event in the
``private_user_data`` section of a room in a v2 /sync.
``account_data`` section of a room in a v2 /sync.
The ``m.tag`` can also be received in a v1 /events response or in the
``private_user_data`` section of a room in v1 /initialSync. ``m.tag``
``account_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.
Each tag has an associated JSON object with information about the tag, e.g how
to order the rooms with a given tag.
Ordering information is given under the ``order`` key as a string. The string
are compared lexicographically by unicode codepoint to determine which should
displayed first. So a room with a tag with an ``order`` key of ``"apples"``
would appear before a room with a tag with an ``order`` key of ``"oranges"``.
If a room has a tag without an ``order`` key then it should appear after the
rooms with that tag that have an ``order`` key.
The name of a tag MUST not exceed 255 bytes.
The name of a tag should be human readable. When displaying tags for a room a
client should display this human readable name. When adding a tag for a room
a client may offer a list to choose from that includes all the tags that the
user has previously set on any of their rooms.
Two special names are listed in the specification:
* ``m.favourite``
* ``m.lowpriority``
{{m_tag_event}}
Client Behaviour