Package io.github.ma1uta.matrix.client.api

Interface ServerDiscoveryApi

  • @Path("/.well-known/matrix/client")
@Produces("application/json")
public interface ServerDiscoveryApi
    In order to allow users to connect to a Matrix server without needing to explicitly specify the homeserver's URL or other parameters, clients SHOULD use an auto-discovery mechanism to determine the server's URL based on a user's Matrix ID. Auto-discovery should only be done at login time.

    • Method Summary

      Modifier and Type Method Description
      void serverDiscovery​(javax.ws.rs.core.UriInfo uriInfo, javax.ws.rs.core.HttpHeaders httpHeaders, javax.ws.rs.container.AsyncResponse asyncResponse)
      Gets discovery information about the domain.

    • Method Detail

      • serverDiscovery

        @GET
@Path("/")
void serverDiscovery​(@Context
                     javax.ws.rs.core.UriInfo uriInfo,
                     @Context
                     javax.ws.rs.core.HttpHeaders httpHeaders,
                     @Suspended
                     javax.ws.rs.container.AsyncResponse asyncResponse)
        Gets discovery information about the domain. The file may include additional keys, which MUST follow the Java package naming convention, e.g. com.example.myapp.property. This ensures property names are suitably namespaced for each application and reduces the risk of clashes.
        Note that this endpoint is not necessarily handled by the homeserver, but by another webserver, to be used for discovering the homeserver URL.
        Return: ServerDiscoveryResponse.

        Status code 200: Server discovery information.

        Status code 404: No server discovery information available.

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