public interface MessagesManager
Modifier and Type | Interface and Description |
---|---|
static interface |
MessagesManager.MessageListener
MessageListener.
|
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 |
sendRoleMessage(String roleName,
Message message)
Send message to all users with specific role.
|
void |
unregisterMessagesListener(String userName,
MessagesManager.MessageListener listener) |
void registerMessagesListener(String userName, MessagesManager.MessageListener listener)
void unregisterMessagesListener(String userName, MessagesManager.MessageListener listener)
int getNumberOfUnclearedMessagesForUser(String userName)
userName
- name of the userint getNumberOfUnclearedMessagesForUserAndByType(String userName, MessageType type)
@Deprecated List<Message> getMessagesForUser(String userName)
getMessageBatch(String, java.util.List, java.util.Map, int, int)
should be used instead because it allows to set the limit and offset parameters.userName
- name of the userList<Message> getMessageBatch(String userName, List<MessageType> types, Map<String,Boolean> sortCriteria, int limit, int offset)
types
- message types to include in the batchsortCriteria
- properties to order by (true if ascending)limit
- max amount of entries to inclde in the batchoffset
- first entry index to queryN = limit
Message
's starting from index = offset
long getMessagesAmount(String userName, List<MessageType> types)
types
- types of messages to take in accountMessage getMessageById(String userName, String messageId)
userName
- name of the uservoid sendMessage(String userName, Message message)
userName
- name of the user to receive the messagemessage
- message to sendvoid sendGroupMessage(String groupName, Message message)
groupName
- name of the group to receive the messagemessage
- message to sendvoid sendRoleMessage(String roleName, Message message)
roleName
- name of the role to receive the messagemessage
- message to sendvoid sendLocalMessage(Message message)
message
- message to sendvoid broadcastMessage(Message message)
message
- message to sendvoid clearMessage(String userName, String messageId)
userName
- name of the user the message belongs tomessageId
- id of messageCopyright © 2021 Magnolia International Ltd.. All rights reserved.