|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object info.magnolia.ui.framework.message.MessagesManagerImpl
@Singleton public class MessagesManagerImpl
Implementation of MessagesManager
.
Nested Class Summary |
---|
Nested classes/interfaces inherited from interface info.magnolia.ui.framework.message.MessagesManager |
---|
MessagesManager.MessageListener |
Constructor Summary | |
---|---|
MessagesManagerImpl(javax.inject.Provider<info.magnolia.cms.security.SecuritySupport> securitySupportProvider,
MessageStore messageStore)
|
Method Summary | |
---|---|
void |
broadcastMessage(info.magnolia.ui.api.message.Message message)
Sends a message to all users. |
void |
clearMessage(String userName,
String messageId)
Marks a message as cleared. |
info.magnolia.ui.api.message.Message |
getMessageById(String userName,
String messageId)
Returns a message. |
List<info.magnolia.ui.api.message.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,
info.magnolia.ui.api.message.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,
info.magnolia.ui.api.message.Message message)
Send message to a specific group. |
void |
sendLocalMessage(info.magnolia.ui.api.message.Message message)
Send message to the current user. |
void |
sendMessage(String userName,
info.magnolia.ui.api.message.Message message)
Send message to a specific user. |
void |
unregisterMessagesListener(String userName,
MessagesManager.MessageListener listener)
|
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
@Inject public MessagesManagerImpl(javax.inject.Provider<info.magnolia.cms.security.SecuritySupport> securitySupportProvider, MessageStore messageStore)
Method Detail |
---|
public void broadcastMessage(info.magnolia.ui.api.message.Message message)
MessagesManager
broadcastMessage
in interface MessagesManager
message
- message to sendpublic void sendMessage(String userName, info.magnolia.ui.api.message.Message message)
MessagesManager
sendMessage
in interface MessagesManager
userName
- name of the user to receive the messagemessage
- message to sendpublic void sendGroupMessage(String groupName, info.magnolia.ui.api.message.Message message)
MessagesManager
sendGroupMessage
in interface MessagesManager
groupName
- name of the group to receive the messagemessage
- message to sendpublic void sendLocalMessage(info.magnolia.ui.api.message.Message message)
MessagesManager
sendLocalMessage
in interface MessagesManager
message
- message to sendpublic void clearMessage(String userName, String messageId)
MessagesManager
clearMessage
in interface MessagesManager
userName
- name of the user the message belongs tomessageId
- id of messagepublic int getNumberOfUnclearedMessagesForUser(String userName)
MessagesManager
getNumberOfUnclearedMessagesForUser
in interface MessagesManager
userName
- name of the user
public List<info.magnolia.ui.api.message.Message> getMessagesForUser(String userName)
MessagesManager
getMessagesForUser
in interface MessagesManager
userName
- name of the user
public info.magnolia.ui.api.message.Message getMessageById(String userName, String messageId)
MessagesManager
getMessageById
in interface MessagesManager
userName
- name of the user
public void registerMessagesListener(String userName, MessagesManager.MessageListener listener)
MessagesManager
registerMessagesListener
in interface MessagesManager
public void unregisterMessagesListener(String userName, MessagesManager.MessageListener listener)
unregisterMessagesListener
in interface MessagesManager
public void removeMessage(String userName, String messageId)
removeMessage
in interface MessagesManager
public int getNumberOfUnclearedMessagesForUserAndByType(String userName, info.magnolia.ui.api.message.MessageType type)
MessagesManager
getNumberOfUnclearedMessagesForUserAndByType
in interface MessagesManager
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |