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

Interface MessagingOperationsService

public interface MessagingOperationsService

CRUD Operation of a Message.

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<FileDataSource> 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 Message specified by the SlingHttpServletRequest using the specified javax.jcr.Session.
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.

Method Detail

create

short create(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(ResourceResolver resolver,
             Resource resource,
             java.lang.String senderAuthId,
             java.util.Map<java.lang.String,java.lang.Object> props,
             java.util.List<FileDataSource> 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 Message

Throws:

OperationException - if there is an error occurs

update

Resource update(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

Resource update(Resource commentResource,
                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

void delete(SlingHttpServletRequest request,
            Session session)
     throws OperationException

Delete a Message specified by the SlingHttpServletRequest using the specified javax.jcr.Session.

Parameters:

request - the http request which specifies the target message.

session - javax.jcr.Session

Throws:

OperationException - if there is an error occurs

delete

void delete(Resource messageResource,
            Session session)
     throws OperationException

Delete a message represented by the specified Resource.

Parameters:

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

session - javax.jcr.Session

Throws:

OperationException - if there is an error occurs