Interface CapabilitiesApi


  • @Path("/_matrix/client/r0")
    @Produces("application/json")
    public interface CapabilitiesApi
    A homeserver may not support certain operations and clients must be able to query for what the homeserver can and can't offer. For example, a homeserver may not support users changing their password as it is configured to perform authentication against an external system.
    • Method Summary

      Modifier and Type Method Description
      void capabilities​(javax.ws.rs.core.UriInfo uriInfo, javax.ws.rs.core.HttpHeaders httpHeaders, javax.ws.rs.container.AsyncResponse asyncResponse)
      Gets information about the server's supported feature set and other relevant capabilities.
    • Method Detail

      • capabilities

        @GET
        @Path("/")
        void capabilities​(@Context
                          javax.ws.rs.core.UriInfo uriInfo,
                          @Context
                          javax.ws.rs.core.HttpHeaders httpHeaders,
                          @Suspended
                          javax.ws.rs.container.AsyncResponse asyncResponse)
        Gets information about the server's supported feature set and other relevant capabilities.
        Requires auth: Yes.
        Rate-limited: Yes.
        Return: CapabilitiesResponse.

        Status code 200: The capabilities of the server.

        Status code 429: This request was rate-limited.

        Parameters:
        uriInfo - Request Information.
        httpHeaders - Http headers.
        asyncResponse - Asynchronous response.