Interface SearchApi


  • @Path("/_matrix/client/r0")
    @Consumes("application/json")
    @Produces("application/json")
    public interface SearchApi
    The search API allows clients to perform full text search across events in all rooms that the user has been in, including those that they have left. Only events that the user is allowed to see will be searched, e.g. it won't include events in rooms that happened after you left.
    • Method Summary

      Modifier and Type Method Description
      void search​(String nextBatch, SearchRequest searchRequest, javax.ws.rs.core.UriInfo uriInfo, javax.ws.rs.core.HttpHeaders httpHeaders, javax.ws.rs.container.AsyncResponse asyncResponse, javax.ws.rs.core.SecurityContext securityContext)
      Performs a full text search across different categories.
    • Method Detail

      • search

        @POST
        @Path("/search")
        void search​(@QueryParam("next_batch")
                    String nextBatch,
                    SearchRequest searchRequest,
                    @Context
                    javax.ws.rs.core.UriInfo uriInfo,
                    @Context
                    javax.ws.rs.core.HttpHeaders httpHeaders,
                    @Suspended
                    javax.ws.rs.container.AsyncResponse asyncResponse,
                    @Context
                    javax.ws.rs.core.SecurityContext securityContext)
        Performs a full text search across different categories.
        Rate-limited: Yes.
        Requires auth: Yes.
        Return: SearchResponse.

        Status code 200: Results of the search.

        Status code 400: Part of the request was invalid.

        Status code 429: This request was rate-limited.

        Parameters:
        nextBatch - The point to return events from. If given, this should be a next_batch result from a previous call to this endpoint.
        searchRequest - JSON body request.
        uriInfo - Request Information.
        httpHeaders - Http headers.
        asyncResponse - Asynchronous response.
        securityContext - Security context.