info.magnolia.ui.framework.message
Interface MessagesManager

All Known Implementing Classes:

MessagesManagerImpl

public interface MessagesManager

Manages users messages.

Nested Class Summary

static interface

MessagesManager.MessageListener MessageListener.

Method Summary

void	broadcastMessage(Message message) Sends a message to all users.
void	clearMessage(String userName, String messageId) Marks a message as cleared.
Message	getMessageById(String userName, String messageId) Returns a message.
List<Message>	getMessagesForUser(String userName) Returns all messages kept for a specific user.
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	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

List<Message> getMessagesForUser(String userName)

Returns all messages kept for a specific user.

Parameters:

userName - name of the user

Returns:

list of messages kept for the user

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)