Package com.gentics.contentnode.rest.resource

Interface MessagingResource

@Produces("application/json") @Consumes("application/json") @Path("/msg") public interface MessagingResource
Messaging resource to access the inbox (list, view, mark read, delete) and send messages

  • Method Details

    • delete

      @DELETE @Path("/{id}") jakarta.ws.rs.core.Response delete(@PathParam("id") int id) throws Exception
      Delete message with given ID
      Parameters:
      id - message id
      Returns:
      response
      Throws:
      Exception

    • send

      @POST @Path("/send") GenericResponse send(MessageSendRequest request) throws Exception
      Send a message to users/groups
      Parameters:
      request - request to send messages
      Returns:
      generic response
      Throws:
      Exception

    • list

      @GET @Path("/list") GenericResponse list(@QueryParam("unread") @DefaultValue("false") boolean unread) throws Exception
      List messages for the current user
      Parameters:
      unread - true if only unread messages shall be shown, false for all messages (default)
      Returns:
      response containing the messages
      Throws:
      Exception

    • read

      @POST @Path("/read") GenericResponse read(MessagesReadRequest request) throws Exception
      Set messages to be read
      Parameters:
      request - request containing the list of messages to be set read
      Returns:
      generic response
      Throws:
      Exception