com.adobe.cq.social.messaging.api

Interface MessageSearch

All Known Subinterfaces:

MessagingService

Deprecated.

@since AEM 6.1

@Deprecated
public interface MessageSearch

Provides methods for retrieving messages.

Method Summary

Modifier and Type	Method and Description
Message	get(Resource root, java.lang.String messageId) Deprecated. get the Message having the given id.
java.util.List<Resource>	getMessageBoxes(Resource root) Deprecated. get all the message boxes present under the passed resource.
java.util.List<Resource>	getMessageBoxes(ResourceResolver resolver, java.lang.String rootPath) Deprecated. get all the message boxes present under the passed parent path.
java.util.Iterator<Message>	search(Resource root, java.util.Map<java.lang.String,java.lang.Object> propertyMap, int first, int last) Deprecated. search for messages rooted at root and matching property values as per the passed property map(conjunction).
java.lang.Iterable<Message>	search(ResourceResolver resolver, MessageFilter filter, int first, int last) Deprecated. Searches for Message satisfying the passed MessageFilter criteria.

Method Detail

search

java.util.Iterator<Message> search(Resource root,
                                   java.util.Map<java.lang.String,java.lang.Object> propertyMap,
                                   int first,
                                   int last)

Deprecated.

search for messages rooted at root and matching property values as per the passed property map(conjunction).

Parameters:

root - resource under which messages are to be searched for.

propertyMap - map containing message properties and values

first - lower limit (inclusive) of the message range to be fetched

last - upper limit (inclusive) of the message range to be fetched

Returns:

Messages satisfying all the properties criteria or null if root passed is null

get

Message get(Resource root,
            java.lang.String messageId)

Deprecated.

get the Message having the given id.

Parameters:

root - parent resource like inbox or sent items

messageId - message id of message to be searched for.

Returns:

Message having the specified id.

getMessageBoxes

java.util.List<Resource> getMessageBoxes(Resource root)

Deprecated.

get all the message boxes present under the passed resource.

Parameters:

root - resource under which message boxes are to be searched.

Returns:

list of message boxes resources.

getMessageBoxes

java.util.List<Resource> getMessageBoxes(ResourceResolver resolver,
                                         java.lang.String rootPath)

Deprecated.

get all the message boxes present under the passed parent path.

Parameters:

rootPath - path under which message boxes are to be searched.

resolver - the resolver to use to get the message boxes.

Returns:

list of message boxes resources.

search

java.lang.Iterable<Message> search(ResourceResolver resolver,
                                   MessageFilter filter,
                                   int first,
                                   int last)
                            throws RepositoryException

Deprecated.

Searches for Message satisfying the passed MessageFilter criteria.

Parameters:

resolver - ResourceResolver to search with.

filter - MessageFilter filtering criteria.

first - lower limit (inclusive) of the message range to be fetched

last - upper limit (inclusive) of the message range to be fetched

Returns:

Search result.

Throws:

RepositoryException - Exception while searching.