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

Mention supported keys

Browse source
This commit is contained in:
Erik Johnston 2015-10-15 11:12:00 +01:00
parent af347baa68
commit c47a94658a
1 changed files with 14 additions and 3 deletions
Download patch file Download diff file Expand all files Collapse all files

17
specification/modules/search.rst
View file

@ -11,11 +11,22 @@ Client behaviour
{{search_http_api}}
Search Categories
~~~~~~~~~~~~~~~~~
-----------------
The search API allows clients to search in different categories of items.
Currently the only specified category is ``room_events``, which include
events in rooms the user had joined.
Currently the only specified category is ``room_events``.
``room_events``
~~~~~~~~~~~~~~~
This category covers all events in rooms that the user had joined. The search
is performed on certain keys of certain event types.
The supported keys to search over are:
- ``content.body`` in ``m.room.message``
- ``content.name`` in ``m.room.name``
- ``content.topic`` in ``m.room.topic``
Security considerations
-----------------------