com.adobe.cq.social.messaging.client.endpoints

Interface MessagingOperations

All Superinterfaces:

CommentOperations

public interface MessagingOperations
extends CommentOperations

CRUD Operation of a MessageSocialComponent.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	MESSAGE_CUSTOM_PROPERTIES_WHITE_LIST Custom properties Names white list service property name.
static java.lang.String	PN_INBOX_PATH_CONFIGURATION inbox path Configuration property name.
static java.lang.String	PN_SENDER_ID_CONFIGURATION sender id Configuration property name.
static java.lang.String	PN_SENT_ITEMS_PATH_CONFIGURATION sent items path Configuration property name.

Method Summary

Modifier and Type	Method and Description
short	create(ResourceResolver resolver, Resource resource, java.lang.String senderAuthId, java.util.Map<java.lang.String,java.lang.Object> props, java.util.List<javax.activation.DataSource> attachments, ClientUtilities clientUtils) Create a a new message with the specified Map of properties and List of attachments.
short	create(SlingHttpServletRequest request) Creates a new message from/based on SlingHttpServletRequest.
void	delete(Resource messageResource, Session session) Delete a message represented by the specified Resource.
void	delete(SlingHttpServletRequest request, Session session) Delete a MessageSocialComponent specified by the SlingHttpServletRequest using the specified Session.
Usage	getUserStatistics(Resource resource) Get the usage statistics of the user corresponding to the passed resolver.
java.util.List<java.lang.String>	getWhiteList() Return a list of message fields that have been whitelisted.
Resource	update(Resource commentResource, java.util.Map<java.lang.String,java.lang.Object> props, java.util.List<FileDataSource> attachments) Update the specified message with the specified Map of properties and List of attachments.
Resource	update(SlingHttpServletRequest request) Update a message based on the specified SlingHttpServletRequest.

Methods inherited from interface com.adobe.cq.social.commons.comments.endpoints.CommentOperations

changeState, changeState, create, create, delete, delete, move, move, removeAttachment, removeAttachment, update, update, uploadImage

Field Detail

MESSAGE_CUSTOM_PROPERTIES_WHITE_LIST

static final java.lang.String MESSAGE_CUSTOM_PROPERTIES_WHITE_LIST

Custom properties Names white list service property name.

See Also:

Constant Field Values

PN_INBOX_PATH_CONFIGURATION

static final java.lang.String PN_INBOX_PATH_CONFIGURATION

inbox path Configuration property name.

See Also:

Constant Field Values

PN_SENT_ITEMS_PATH_CONFIGURATION

static final java.lang.String PN_SENT_ITEMS_PATH_CONFIGURATION

sent items path Configuration property name.

See Also:

Constant Field Values

PN_SENDER_ID_CONFIGURATION

static final java.lang.String PN_SENDER_ID_CONFIGURATION

sender id Configuration property name.

See Also:

Constant Field Values

Method Detail

create

short create(@Nonnull
             SlingHttpServletRequest request)
      throws OperationException

Creates a new message from/based on SlingHttpServletRequest.

Parameters:

request - the client request

Returns:

Http response status code.

Throws:

OperationException - if there is an error occurs

create

short create(@Nonnull
             ResourceResolver resolver,
             @Nonnull
             Resource resource,
             @Nonnull
             java.lang.String senderAuthId,
             @Nonnull
             java.util.Map<java.lang.String,java.lang.Object> props,
             @Nonnull
             java.util.List<javax.activation.DataSource> attachments,
             ClientUtilities clientUtils)
      throws OperationException

Create a a new message with the specified Map of properties and List of attachments.

Parameters:

resolver - the root resource of the message to be created.

resource - the resource that triggered the message creation.

senderAuthId - Authorizable Id of the message sender.

props - message properties passed as a java map.

attachments - List of FileDataSource of the message attachments.

clientUtils - A ClientUtilities object.

Returns:

the new MessageSocialComponent

Throws:

OperationException - if there is an error occurs

update

@Nonnull
Resource update(@Nonnull
                         SlingHttpServletRequest request)
                  throws OperationException

Update a message based on the specified SlingHttpServletRequest.

Parameters:

request - The SlingHttpServletRequest.

Returns:

the update message.

Throws:

OperationException - if there is an error occurs

update

@Nonnull
Resource update(@Nonnull
                         Resource commentResource,
                         @Nonnull
                         java.util.Map<java.lang.String,java.lang.Object> props,
                         java.util.List<FileDataSource> attachments)
                  throws OperationException

Update the specified message with the specified Map of properties and List of attachments.

Parameters:

commentResource - the target message resource.

props - a map of the properties to be updated

attachments - a list of attachment to be added to the specified message.

Returns:

the new updated message resource.

Throws:

OperationException - if there is an error occurs

delete

@Nonnull
void delete(@Nonnull
                     SlingHttpServletRequest request,
                     @Nonnull
                     Session session)
              throws OperationException

Delete a MessageSocialComponent specified by the SlingHttpServletRequest using the specified Session.

Specified by:

delete in interface CommentOperations

Parameters:

request - the http request which specifies the target message.

session - Session

Throws:

OperationException - if there is an error occurs

delete

@Nonnull
void delete(@Nonnull
                     Resource messageResource,
                     @Nonnull
                     Session session)
              throws OperationException

Delete a message represented by the specified Resource.

Specified by:

delete in interface CommentOperations

Parameters:

messageResource - The Resource that is the message to be deleted.

session - Session

Throws:

OperationException - if there is an error occurs

getUserStatistics

@Nonnull
Usage getUserStatistics(@Nonnull
                                 Resource resource)
                          throws RepositoryException

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

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

Return a list of message fields that have been whitelisted.

Returns:

List of field names that are on the whitelist.