2015-10-14 17:13:43 +02:00
|
|
|
Server Side Search
|
|
|
|
|
==================
|
|
|
|
|
|
|
|
|
|
.. _module:search:
|
|
|
|
|
|
2015-10-14 18:20:00 +02:00
|
|
|
The search API allows clients to perform full text search across events in
|
|
|
|
|
their rooms without having to download the entire histories.
|
2015-10-14 17:13:43 +02:00
|
|
|
|
|
|
|
|
Client behaviour
|
|
|
|
|
----------------
|
|
|
|
|
{{search_http_api}}
|
|
|
|
|
|
2015-10-15 12:02:37 +02:00
|
|
|
Search Categories
|
2015-10-15 12:12:00 +02:00
|
|
|
-----------------
|
2015-10-15 12:02:37 +02:00
|
|
|
|
|
|
|
|
The search API allows clients to search in different categories of items.
|
2015-10-15 12:12:00 +02:00
|
|
|
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``
|
2015-10-15 12:02:37 +02:00
|
|
|
|
2015-10-14 17:13:43 +02:00
|
|
|
Security considerations
|
|
|
|
|
-----------------------
|
|
|
|
|
The server must only return results that the user has permission to see.
|
2015-10-14 17:26:14 +02:00
|
|
|
|
