com.gentics.contentnode.rest.resource

Interface MessagingResource

@Produces(value={"application/json","application/xml"})
 @Consumes(value={"application/json","application/xml"})
 @Path(value="/msg")
public interface MessagingResource

Messaging resource to access the inbox (list, view, mark read, delete) and send messages

Method Summary

Modifier and Type	Method and Description
javax.ws.rs.core.Response	delete(int id) Delete message with given ID
GenericResponse	list(boolean unread) List messages for the current user
GenericResponse	read(MessagesReadRequest request) Set messages to be read
GenericResponse	send(MessageSendRequest request) Send a message to users/groups

Method Detail

delete

@DELETE
 @Path(value="/{id}")
javax.ws.rs.core.Response delete(@PathParam(value="id")
                                                               int id)
                                                        throws Exception

Delete message with given ID

Parameters:

id - message id

Returns:

response

Throws:

Exception

send

@POST
 @Path(value="/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(value="/list")
GenericResponse list(@QueryParam(value="unread") @DefaultValue(value="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(value="/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