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

Interface ClientConfigApi

  • @Path("/_matrix/client/r0/user")
@Consumes("application/json")
@Produces("application/json")
public interface ClientConfigApi
    Client Behaviour.

    • Method Summary

      Modifier and Type Method Description
      void addConfig​(String userId, String type, Map<String,​Object> accountData, javax.ws.rs.core.UriInfo uriInfo, javax.ws.rs.core.HttpHeaders httpHeaders, javax.ws.rs.container.AsyncResponse asyncResponse, javax.ws.rs.core.SecurityContext securityContext)
      Set some account_data for the client.
      void addRoomConfig​(String userId, String roomId, String type, Map<String,​Object> accountData, javax.ws.rs.core.UriInfo uriInfo, javax.ws.rs.core.HttpHeaders httpHeaders, javax.ws.rs.container.AsyncResponse asyncResponse, javax.ws.rs.core.SecurityContext securityContext)
      Set some account_data for the client on a given room.
      void getConfig​(String userId, String type, javax.ws.rs.core.UriInfo uriInfo, javax.ws.rs.core.HttpHeaders httpHeaders, javax.ws.rs.container.AsyncResponse asyncResponse, javax.ws.rs.core.SecurityContext securityContext)
      Get some account_data for the client.
      void getRoomConfig​(String userId, String roomId, String type, javax.ws.rs.core.UriInfo uriInfo, javax.ws.rs.core.HttpHeaders httpHeaders, javax.ws.rs.container.AsyncResponse asyncResponse, javax.ws.rs.core.SecurityContext securityContext)
      Get some account_data for the client on a given room.

    • Method Detail

      • getConfig

        @GET
@Path("/{userId}/account_data/{type}")
void getConfig​(@PathParam("userId")
               String userId,
               @PathParam("type")
               String type,
               @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)
        Get some account_data for the client. This config is only visible to the user that set the account_data.
        Requires auth: Yes.
        Return: Map.

        Status code 200: The account data content for the given type.

        Parameters:
        userId - Required. The id of the user to set account_data for. The access token must be authorized to make requests for this user id.
        type - Required. The event type of the account_data to set. Custom types should be namespaced to avoid clashes.
        uriInfo - Request Information.
        httpHeaders - Http headers.
        asyncResponse - Asynchronous response.
        securityContext - Security context.

      • addConfig

        @PUT
@Path("/{userId}/account_data/{type}")
void addConfig​(@PathParam("userId")
               String userId,
               @PathParam("type")
               String type,
               Map<String,​Object> accountData,
               @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)
        Set some account_data for the client. This config is only visible to the user that set the account_data. The config will be synced to clients in the top-level account_data.
        Requires auth: Yes.
        Return: EmptyResponse.

        Status code 200: The account_data was successfully added.

        Parameters:
        userId - Required. The id of the user to set account_data for. The access token must be authorized to make requests for this user id.
        type - Required. The event type of the account_data to set. Custom types should be namespaced to avoid clashes.
        accountData - Account data.
        uriInfo - Request Information.
        httpHeaders - Http headers.
        asyncResponse - Asynchronous response.
        securityContext - Security context.

      • getRoomConfig

        @GET
@Path("/{userId}/rooms/{roomId}/account_data/{type}")
void getRoomConfig​(@PathParam("userId")
                   String userId,
                   @PathParam("roomId")
                   String roomId,
                   @PathParam("type")
                   String type,
                   @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)
        Get some account_data for the client on a given room. This config is only visible to the user that set the account_data.
        Requires auth: Yes.
        Return: Map.

        Status code 200: The account data content for the given type.

        Parameters:
        userId - Required. The id of the user to set account_data for. The access token must be authorized to make requests for this user id.
        roomId - Required. The id of the room to set account_data on.
        type - Required. The event type of the account_data to set. Custom types should be namespaced to avoid clashes.
        uriInfo - Request Information.
        httpHeaders - Http headers.
        asyncResponse - Asynchronous response.
        securityContext - Security context.

      • addRoomConfig

        @PUT
@Path("/{userId}/rooms/{roomId}/account_data/{type}")
void addRoomConfig​(@PathParam("userId")
                   String userId,
                   @PathParam("roomId")
                   String roomId,
                   @PathParam("type")
                   String type,
                   Map<String,​Object> accountData,
                   @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)
        Set some account_data for the client on a given room. This config is only visible to the user that set the account_data. The config will be synced to clients in the per-room account_data.
        Requires auth: Yes.
        Return: EmptyResponse.

        Status code 200: The account_data was successfully added.

        Parameters:
        userId - Required. The id of the user to set account_data for. The access token must be authorized to make requests for this user id.
        roomId - Required. The id of the room to set account_data on.
        type - Required. The event type of the account_data to set. Custom types should be namespaced to avoid clashes.
        accountData - account data.
        uriInfo - Request Information.
        httpHeaders - Http headers.
        asyncResponse - Asynchronous response.
        securityContext - Security context.