com.gentics.contentnode.rest.resource
Interface MessagingResource

All Superinterfaces:
AuthenticatedResource

public interface MessagingResource
extends AuthenticatedResource

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


Method Summary
 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
 
Methods inherited from interface com.gentics.contentnode.rest.resource.AuthenticatedResource
setSessionId
 

Method Detail

send

GenericResponse send(MessageSendRequest request)
Send a message to users/groups

Parameters:
request - request to send messages
Returns:
generic response

list

GenericResponse list(boolean unread)
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

read

GenericResponse read(MessagesReadRequest request)
Set messages to be read

Parameters:
request - request containing the list of messages to be set read
Returns:
generic response


Copyright © 2015 Gentics Software GmbH. All Rights Reserved.