Package io.github.ma1uta.matrix.application.api

Interface RoomServiceApi

  • @Path("/_matrix/client/r0/directory/list/appservice")
@Consumes("application/json")
@Produces("application/json")
public interface RoomServiceApi
    Application services can maintain their own room directories for their defined third party protocols. These room directories may be accessed by clients through additional parameters on the /publicRooms client-server endpoint.

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Interface Description
      static class  RoomServiceApi.Visibility
      Room visibility.

    • Method Summary

      Modifier and Type Method Description
      void updateVisibility​(String networkId, String roomId, RoomVisibility roomVisibility, javax.ws.rs.core.UriInfo uriInfo, javax.ws.rs.core.HttpHeaders httpHeaders, javax.ws.rs.container.AsyncResponse asyncResponse)
      Updates the visibility of a given room on the application service's room directory.

    • Method Detail

      • updateVisibility

        @PUT
@Path("/{networkId}/{roomId}")
void updateVisibility​(@PathParam("networkId")
                      String networkId,
                      @PathParam("roomId")
                      String roomId,
                      RoomVisibility roomVisibility,
                      @Context
                      javax.ws.rs.core.UriInfo uriInfo,
                      @Context
                      javax.ws.rs.core.HttpHeaders httpHeaders,
                      @Suspended
                      javax.ws.rs.container.AsyncResponse asyncResponse)
        Updates the visibility of a given room on the application service's room directory.
        This API is similar to the room directory visibility API used by clients to update the homeserver's more general room directory.
        This API requires the use of an application service access token (as_token) instead of a typical client's access_token. This API cannot be invoked by users who are not identified as application services.
        Return: EmptyResponse.

        Status code 200: The room's directory visibility has been updated.

        Parameters:
        networkId - Required. The protocol (network) ID to update the room list for. This would have been provided by the application service as being listed as a supported protocol.
        roomId - Required. The room ID to add to the directory.
        roomVisibility - Required. JSON body request.
        uriInfo - Information about the request.
        httpHeaders - Http headers.
        asyncResponse - Asynchronous response.