com.adobe.cq.social.messaging.api

Interface MessagingService

All Superinterfaces:

MessageSearch

Deprecated.

@since AEM 6.1

@Deprecated
public interface MessagingService
extends MessageSearch

Messaging service exposed for sending messages. Also extends MessageSearch for retrieving messages.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	MESSAGE_CUSTOM_PROPERTIES_WHITE_LIST Deprecated. Custom properties Names whitelist service property name.

Method Summary

Modifier and Type	Method and Description
void	delete(java.util.List<Resource> messageResourceList, ResourceResolver resourceResolver) Deprecated. Use MessagingOperationsService instead.
Usage	getUserStatistics(Resource resource) Deprecated. get the usage statistics of the user corresponding to the passed resolver.
java.util.List<java.lang.String>	getWhiteList() Deprecated. Return a list of message fields that have been whitelisted.
MessageBuilder	newMessageSender(java.lang.String senderId, java.lang.String asiPath, boolean isFiltered) Deprecated. return a new MessageBuilder.
void	setCustomProperty(java.util.List<Message> messageList, java.lang.String name, java.lang.Object value, ResourceResolver resourceResolver) Deprecated. Use MessagingOperationsService instead.
void	setDeleted(java.util.List<Message> messageList, boolean value, ResourceResolver resourceResolver) Deprecated. Use MessagingOperationsService instead.
void	setRead(java.util.List<Message> messageList, boolean value, ResourceResolver resourceResolver) Deprecated. Use MessagingOperationsService instead.

Methods inherited from interface com.adobe.cq.social.messaging.api.MessageSearch

get, getMessageBoxes, getMessageBoxes, search, search

Field Detail

MESSAGE_CUSTOM_PROPERTIES_WHITE_LIST

static final java.lang.String MESSAGE_CUSTOM_PROPERTIES_WHITE_LIST

Deprecated.

Custom properties Names whitelist service property name.

See Also:

Constant Field Values

Method Detail

newMessageSender

MessageBuilder newMessageSender(java.lang.String senderId,
                                java.lang.String asiPath,
                                boolean isFiltered)

Deprecated.

return a new MessageBuilder.

Parameters:

senderId - user id of the sender.

asiPath - the asiPath to be prefixed to the message resource path

isFiltered - if true, the white list filtering is applied

Returns:

a new message sender.

setRead

@Deprecated
void setRead(java.util.List<Message> messageList,
                         boolean value,
                         ResourceResolver resourceResolver)
                  throws PersistenceException

Deprecated. Use MessagingOperationsService instead.

mark all the messages in message list as read or unread.

Parameters:

messageList - list of Messages

value - true if the message is to be marked read, false otherwise.

resourceResolver - ResourceResolver

Throws:

PersistenceException - in case of failure on session save.

setDeleted

@Deprecated
void setDeleted(java.util.List<Message> messageList,
                            boolean value,
                            ResourceResolver resourceResolver)
                     throws PersistenceException

Deprecated. Use MessagingOperationsService instead.

mark all the messages in message list as trashed or un-trashed.

Parameters:

messageList - list of Messages

value - true if the message is to be marked trashed, false otherwise.

resourceResolver - ResourceResolver

Throws:

PersistenceException - in case of failure on session save.

setCustomProperty

@Deprecated
void setCustomProperty(java.util.List<Message> messageList,
                                   java.lang.String name,
                                   java.lang.Object value,
                                   ResourceResolver resourceResolver)
                            throws PersistenceException

Deprecated. Use MessagingOperationsService instead.

change the value of an existing custom property on all messages in message list.

Parameters:

messageList - list of Messages

name - name of property to be set

value - value to be set

resourceResolver - ResourceResolver

Throws:

PersistenceException - in case of failure on session save.

delete

@Deprecated
void delete(java.util.List<Resource> messageResourceList,
                        ResourceResolver resourceResolver)
                 throws PersistenceException

Deprecated. Use MessagingOperationsService instead.

permanently delete all the messages in message list.

Parameters:

messageResourceList - list of Message Resource

resourceResolver - ResourceResolver

Throws:

PersistenceException - in case of failure on session save.

getUserStatistics

Usage getUserStatistics(Resource resource)
                 throws RepositoryException

Deprecated.

get the usage statistics of the user corresponding to the passed resolver.

Parameters:

resource - The message box resource.

Returns:

Usage

Throws:

RepositoryException - RepositoryException if some exception occurs in calculating the statistics.

getWhiteList

java.util.List<java.lang.String> getWhiteList()

Deprecated.

Return a list of message fields that have been whitelisted.

Returns:

List of field names that are on the whitelist.