matrix-spec/specification/modules/search.rst

24 lines
594 B
ReStructuredText
Raw Normal View History

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
~~~~~~~~~~~~~~~~~
The search API allows clients to search in different categories of items.
2015-10-15 12:06:15 +02:00
Currently the only specified category is ``room_events``, which include
2015-10-15 12:02:37 +02:00
events in rooms the user had joined.
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