public interface MessagingOperations extends CommentOperations
MessageSocialComponent
.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. |
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 . |
changeState, changeState, create, create, delete, delete, move, move, removeAttachment, removeAttachment, update, update, uploadImage
static final java.lang.String MESSAGE_CUSTOM_PROPERTIES_WHITE_LIST
static final java.lang.String PN_INBOX_PATH_CONFIGURATION
Configuration
property name.static final java.lang.String PN_SENT_ITEMS_PATH_CONFIGURATION
Configuration
property name.static final java.lang.String PN_SENDER_ID_CONFIGURATION
Configuration
property name.short create(@Nonnull SlingHttpServletRequest request) throws OperationException
SlingHttpServletRequest
.request
- the client requestOperationException
- if there is an error occursshort 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
Map
of properties and List
of
attachments.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.MessageSocialComponent
OperationException
- if there is an error occurs@Nonnull Resource update(@Nonnull SlingHttpServletRequest request) throws OperationException
SlingHttpServletRequest
.request
- The SlingHttpServletRequest
.OperationException
- if there is an error occurs@Nonnull Resource update(@Nonnull Resource commentResource, @Nonnull java.util.Map<java.lang.String,java.lang.Object> props, java.util.List<FileDataSource> attachments) throws OperationException
Map
of properties and List
of attachments.commentResource
- the target message resource.props
- a map of the properties to be updatedattachments
- a list of attachment to be added to the specified message.OperationException
- if there is an error occurs@Nonnull void delete(@Nonnull SlingHttpServletRequest request, @Nonnull Session session) throws OperationException
MessageSocialComponent
specified by the
SlingHttpServletRequest
using the specified Session
.delete
in interface CommentOperations
request
- the http request which specifies the target message.session
- Session
OperationException
- if there is an error occurs@Nonnull void delete(@Nonnull Resource messageResource, @Nonnull Session session) throws OperationException
Resource
.delete
in interface CommentOperations
messageResource
- The Resource
that is the message to be deleted.session
- Session
OperationException
- if there is an error occurs@Nonnull Usage getUserStatistics(@Nonnull Resource resource) throws RepositoryException
resource
- The message box resource.Usage
RepositoryException
- RepositoryException
if some exception occurs in calculating the statistics.@Nonnull java.util.List<java.lang.String> getWhiteList()
Copyright © 2010 - 2020 Adobe. All Rights Reserved