public interface MessagingService extends MessageSearch
MessageSearch
for retrieving messages.Modifier and Type | Field and Description |
---|---|
static String |
MESSAGE_CUSTOM_PROPERTIES_WHITE_LIST
Custom properties Names whitelist service property name.
|
Modifier and Type | Method and Description |
---|---|
void |
delete(List<Message> messageList,
ResourceResolver resourceResolver)
permanently delete all the messages in message list.
|
Usage |
getUserStatistics(ResourceResolver resolver)
get the usage statistics of the user corresponding to the passed resolver.
|
MessageBuilder |
newMessageSender(ResourceResolver resourceResolver)
Deprecated.
use
newMessageSender(String, boolean) instead |
MessageBuilder |
newMessageSender(String senderId,
boolean isFiltered)
return a new
MessageBuilder . |
void |
setCustomProperty(List<Message> messageList,
String name,
Object value,
ResourceResolver resourceResolver)
change the value of an existing custom property on all messages in message list.
|
void |
setDeleted(List<Message> messageList,
boolean value,
ResourceResolver resourceResolver)
mark all the messages in message list as trashed or un-trashed.
|
void |
setRead(List<Message> messageList,
boolean value,
ResourceResolver resourceResolver)
mark all the messages in message list as read or unread.
|
get, getMessageBoxes, search, search
static final String MESSAGE_CUSTOM_PROPERTIES_WHITE_LIST
@Deprecated MessageBuilder newMessageSender(ResourceResolver resourceResolver)
newMessageSender(String, boolean)
insteadMessageBuilder
.resourceResolver
- ResourceResolver
MessageBuilder newMessageSender(String senderId, boolean isFiltered)
MessageBuilder
.senderId
- user id of the sender.isFiltered
- if true, the white list filtering is appliedvoid setRead(List<Message> messageList, boolean value, ResourceResolver resourceResolver) throws PersistenceException
messageList
- list of Message
svalue
- true if the message is to be marked read, false otherwise.resourceResolver
- ResourceResolver
PersistenceException
- in case of failure on session save.void setDeleted(List<Message> messageList, boolean value, ResourceResolver resourceResolver) throws PersistenceException
messageList
- list of Message
svalue
- true if the message is to be marked trashed, false otherwise.resourceResolver
- ResourceResolver
PersistenceException
- in case of failure on session save.void setCustomProperty(List<Message> messageList, String name, Object value, ResourceResolver resourceResolver) throws PersistenceException
messageList
- list of Message
sname
- name of property to be setvalue
- value to be setresourceResolver
- ResourceResolver
PersistenceException
- in case of failure on session save.void delete(List<Message> messageList, ResourceResolver resourceResolver) throws PersistenceException
messageList
- list of Message
sresourceResolver
- ResourceResolver
PersistenceException
- in case of failure on session save.Usage getUserStatistics(ResourceResolver resolver) throws RepositoryException
resolver
- ResourceResolver
of the user whose statistics is to be known.Usage
RepositoryException
- RepositoryException
if some exception occurs in calculating the statistics."Copyright © 2006 - 2015 Adobe Systems Incorporated. All Rights Reserved"