info.magnolia.ui.framework.message

Interface MessagesManager

All Known Implementing Classes:

MessagesManagerImpl

public interface MessagesManager

Manages users messages.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	MessagesManager.MessageListener MessageListener.

Method Summary

Methods

Modifier and Type	Method and Description
void	broadcastMessage(Message message) Sends a message to all users.
void	clearMessage(String userName, String messageId) Marks a message as cleared.
List<Message>	getMessageBatch(String userName, List<MessageType> types, Map<String,Boolean> sortCriteria, int limit, int offset) More efficient way to query message objects - the amount of return payload is limited, pre-sorted and filtered by type.
Message	getMessageById(String userName, String messageId) Returns a message.
long	getMessagesAmount(String userName, List<MessageType> types) Get amount of messages of certain types.
List<Message>	getMessagesForUser(String userName) Deprecated. since 5.3.9 - potentially dangerous since it returns the whole set of messages for the user which could be large. The getMessageBatch(String, java.util.List, java.util.Map, int, int) should be used instead because it allows to set the limit and offset parameters.
int	getNumberOfUnclearedMessagesForUser(String userName) Returns the number of uncleared (unread) messages for this user.
int	getNumberOfUnclearedMessagesForUserAndByType(String userName, MessageType type) Returns the number of uncleared (unread) messages for this user and for the specific message type.
void	registerMessagesListener(String userName, MessagesManager.MessageListener listener) Beware: this method is for registering message listeners and should only be used by the entry point of our application AdmincentralUI where we register a dispatcher.
void	removeMessage(String userName, String messageId)
void	saveMessage(String userName, Message message)
void	sendGroupMessage(String groupName, Message message) Send message to a specific group.
void	sendLocalMessage(Message message) Send message to the current user.
void	sendMessage(String userName, Message message) Send message to a specific user.
void	unregisterMessagesListener(String userName, MessagesManager.MessageListener listener)

Method Detail

registerMessagesListener

void registerMessagesListener(String userName,
                            MessagesManager.MessageListener listener)

Beware: this method is for registering message listeners and should only be used by the entry point of our application AdmincentralUI where we register a dispatcher. If you'll use it to register your own MessageListeners this likely to introduce a memory leak. You should listen to the MessageEvent instead.

unregisterMessagesListener

void unregisterMessagesListener(String userName,
                              MessagesManager.MessageListener listener)

getNumberOfUnclearedMessagesForUser

int getNumberOfUnclearedMessagesForUser(String userName)

Returns the number of uncleared (unread) messages for this user.

Parameters:

userName - name of the user

Returns:

number of uncleared messages

getNumberOfUnclearedMessagesForUserAndByType

int getNumberOfUnclearedMessagesForUserAndByType(String userName,
                                               MessageType type)

Returns the number of uncleared (unread) messages for this user and for the specific message type.

getMessagesForUser

@Deprecated
List<Message> getMessagesForUser(String userName)

Deprecated. since 5.3.9 - potentially dangerous since it returns the whole set of messages for the user which could be large. The getMessageBatch(String, java.util.List, java.util.Map, int, int) should be used instead because it allows to set the limit and offset parameters.

Returns all messages kept for a specific user.

Parameters:

userName - name of the user

Returns:

list of messages kept for the user

getMessageBatch

List<Message> getMessageBatch(String userName,
                            List<MessageType> types,
                            Map<String,Boolean> sortCriteria,
                            int limit,
                            int offset)

More efficient way to query message objects - the amount of return payload is limited, pre-sorted and filtered by type.

Parameters:

types - message types to include in the batch

sortCriteria - properties to order by (true if ascending)

limit - max amount of entries to inclde in the batch

offset - first entry index to query

Returns:

list of N = limit Message's starting from index = offset

getMessagesAmount

long getMessagesAmount(String userName,
                     List<MessageType> types)

Get amount of messages of certain types.

Parameters:

types - types of messages to take in account

Returns:

amount of messages of certain types

getMessageById

Message getMessageById(String userName,
                     String messageId)

Returns a message.

Parameters:

userName - name of the user

Returns:

list of messages kept for the user

sendMessage

void sendMessage(String userName,
               Message message)

Send message to a specific user.

Parameters:

userName - name of the user to receive the message

message - message to send

sendGroupMessage

void sendGroupMessage(String groupName,
                    Message message)

Send message to a specific group.

Parameters:

groupName - name of the group to receive the message

message - message to send

sendLocalMessage

void sendLocalMessage(Message message)

Send message to the current user.

Parameters:

message - message to send

broadcastMessage

void broadcastMessage(Message message)

Sends a message to all users.

Parameters:

message - message to send

clearMessage

void clearMessage(String userName,
                String messageId)

Marks a message as cleared.

Parameters:

userName - name of the user the message belongs to

messageId - id of message

removeMessage

void removeMessage(String userName,
                 String messageId)

saveMessage

void saveMessage(String userName,
               Message message)