com.adobe.cq.social.messaging.client.api

Interface MessageSocialComponent<T extends CommentCollectionConfiguration>

All Superinterfaces:

Comment<T>, SocialCollectionComponent, SocialComponent

public interface MessageSocialComponent<T extends CommentCollectionConfiguration>
extends Comment<T>

Represents a single Social Messaging message.

Nested Class Summary

Nested classes/interfaces inherited from interface com.adobe.cq.social.commons.comments.api.Comment

Comment.ModeratorActions, Comment.ModeratorStatus, Comment.Tag

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	MESSAGE_RESOURCE_TYPE Resource type for message.
static java.lang.String	NT_MESSAGE_NODE_TYPE node type for message Nodes.
static java.lang.String	PN_MESSAGE_BASE property to specify message base page path.
static java.lang.String	PN_MESSAGE_CONTENT property to specify message content.
static java.lang.String	PN_MESSAGE_DELETED property to specify trashed or not.
static java.lang.String	PN_MESSAGE_ID property to specify message id.
static java.lang.String	PN_MESSAGE_READ property to specify to specify read or unread.
static java.lang.String	PN_MESSAGE_RECIPIENT_NAMES property to specify recipients' names.
static java.lang.String	PN_MESSAGE_RECIPIENTS property to specify recipients.
static java.lang.String	PN_MESSAGE_SELECTOR property to specify message service selector.
static java.lang.String	PN_MESSAGE_SENDER property to specify sender id.
static java.lang.String	PN_MESSAGE_SENDER_NAME property to specify sender name.
static java.lang.String	PN_MESSAGE_SIZE property name for size of message.
static java.lang.String	PN_MESSAGE_SUBJECT property to specify message subject.
static java.lang.String	PN_MESSAGE_TIMESTAMP property to specify time stamp of message.
static java.lang.String	PN_MESSAGE_URL property to specify message url.

Fields inherited from interface com.adobe.cq.social.commons.comments.api.Comment

COMMENT_RESOURCETYPE, COMMENTCOLLECTION_RESOURCETYPE, JSON_EXTENSION, NODE_TYPE, PROP_APPROVED, PROP_REFERER, PROP_SPAM, PROP_USE_REFERRER_URL, SOCO_SELECTOR

Fields inherited from interface com.adobe.cq.social.scf.SocialComponent

CSV_SELECTOR, DEFAULT_SELECTOR, INDEX_SELECTOR, QUERY_SELECTOR, TRANSLATE_SELECTOR

Method Summary

Modifier and Type	Method and Description
java.util.List<Attachment>	getAttachmentsList() Retrieves a list, an entry of which represents Attachment.
java.util.Map<java.lang.String,java.lang.Object>	getCustomProperties()
java.lang.String	getMessageBoxPath()
java.lang.String	getMessageBoxRelativePath() Get the relative path of this message's message box from the user's node.
java.lang.String	getMessageID()
java.util.List<MessagingUser>	getRecipients() Get recipients of a message.
java.util.List<java.lang.String>	getRecipientsNames() Get the names of the recipients of a message
MessagingUser	getSender() Get message sender.
java.lang.String	getSubject()
java.util.Calendar	getTimestamp()
boolean	isDeleted()
boolean	isRead()
boolean	setDeleted(boolean value) mark the message as trashed or un-trashed.
boolean	setRead(boolean value) mark the message as read or unread.

Methods inherited from interface com.adobe.cq.social.commons.comments.api.Comment

getAttachment, getAttachments, getAuthor, getCanDelete, getCanEdit, getCanReply, getCanTranslate, getConfiguration, getCreated, getCurrentUserFlagText, getFlagReasons, getMessage, getModeratorActions, getModeratorStatus, getPageInfo, getParentId, getPublishDate, getReferrerUrl, getSourceComponentId, getState, getTags, getTranslationAttribution, getTranslationDescription, getTranslationDisplay, getTranslationTitle, getUseFlagReasons, getVotes, isApproved, isClosed, isDraft, isFeatured, isFlaggedByUser, isPinned, isScheduled, isTopLevel, isUserModerator, isVisible

Methods inherited from interface com.adobe.cq.social.scf.SocialCollectionComponent

getItems, getTotalSize, setPagination, setSortedOrder

Methods inherited from interface com.adobe.cq.social.scf.SocialComponent

getAsMap, getFriendlyUrl, getId, getParentComponent, getProperties, getProperty, getProperty, getResource, getResourceType, getSourceComponent, getUrl, toJSONString

Field Detail

MESSAGE_RESOURCE_TYPE

static final java.lang.String MESSAGE_RESOURCE_TYPE

Resource type for message.

See Also:

Constant Field Values

PN_MESSAGE_ID

static final java.lang.String PN_MESSAGE_ID

property to specify message id.

See Also:

Constant Field Values

PN_MESSAGE_BASE

static final java.lang.String PN_MESSAGE_BASE

property to specify message base page path.

See Also:

Constant Field Values

PN_MESSAGE_SELECTOR

static final java.lang.String PN_MESSAGE_SELECTOR

property to specify message service selector.

See Also:

Constant Field Values

PN_MESSAGE_URL

static final java.lang.String PN_MESSAGE_URL

property to specify message url.

See Also:

Constant Field Values

PN_MESSAGE_RECIPIENTS

static final java.lang.String PN_MESSAGE_RECIPIENTS

property to specify recipients.

See Also:

Constant Field Values

PN_MESSAGE_SENDER_NAME

static final java.lang.String PN_MESSAGE_SENDER_NAME

property to specify sender name.

See Also:

Constant Field Values

PN_MESSAGE_RECIPIENT_NAMES

static final java.lang.String PN_MESSAGE_RECIPIENT_NAMES

property to specify recipients' names.

See Also:

Constant Field Values

PN_MESSAGE_SUBJECT

static final java.lang.String PN_MESSAGE_SUBJECT

property to specify message subject.

See Also:

Constant Field Values

PN_MESSAGE_CONTENT

static final java.lang.String PN_MESSAGE_CONTENT

property to specify message content.

See Also:

Constant Field Values

PN_MESSAGE_SENDER

static final java.lang.String PN_MESSAGE_SENDER

property to specify sender id.

See Also:

Constant Field Values

PN_MESSAGE_READ

static final java.lang.String PN_MESSAGE_READ

property to specify to specify read or unread.

See Also:

Constant Field Values

PN_MESSAGE_DELETED

static final java.lang.String PN_MESSAGE_DELETED

property to specify trashed or not.

See Also:

Constant Field Values

PN_MESSAGE_TIMESTAMP

static final java.lang.String PN_MESSAGE_TIMESTAMP

property to specify time stamp of message.

See Also:

Constant Field Values

NT_MESSAGE_NODE_TYPE

static final java.lang.String NT_MESSAGE_NODE_TYPE

node type for message Nodes.

See Also:

Constant Field Values

PN_MESSAGE_SIZE

static final java.lang.String PN_MESSAGE_SIZE

property name for size of message.

See Also:

Constant Field Values

Method Detail

getCustomProperties

@CheckForNull
java.util.Map<java.lang.String,java.lang.Object> getCustomProperties()

Returns:

custom properties.

getSubject

@Nonnull
java.lang.String getSubject()

Returns:

message subject.

getTimestamp

@CheckForNull
java.util.Calendar getTimestamp()

Returns:

message's timestamp.

getMessageBoxRelativePath

@CheckForNull
java.lang.String getMessageBoxRelativePath()

Get the relative path of this message's message box from the user's node.

Returns:

relative path of this message's message box to user's node.

getSender

@CheckForNull
MessagingUser getSender()

Get message sender.

Returns:

MessagingUser.

getRecipients

@Nonnull
java.util.List<MessagingUser> getRecipients()

Get recipients of a message.

Returns:

list of MessagingUser.

getRecipientsNames

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

Get the names of the recipients of a message

Returns:

list of the recipient's names

isRead

@Nonnull
boolean isRead()

Returns:

true if message is read, false otherwise.

isDeleted

@Nonnull
boolean isDeleted()

Returns:

true if the message has been deleted (move to trash), false otherwise.

getMessageID

@CheckForNull
java.lang.String getMessageID()

Returns:

message id.

getMessageBoxPath

@CheckForNull
java.lang.String getMessageBoxPath()

Returns:

absolute path of this message's message box.

getAttachmentsList

java.util.List<Attachment> getAttachmentsList()

Retrieves a list, an entry of which represents Attachment. The list contains all the attachments of the message.

Returns:

A List representing the available attachments, or an empty list if no attachments are present.

setDeleted

boolean setDeleted(boolean value)

mark the message as trashed or un-trashed.

Parameters:

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

Returns:

true if existing value on message was different from passed value, false otherwise.

setRead

boolean setRead(boolean value)

mark the message as read or unread.

Parameters:

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

Returns:

true if existing value on message was different from passed value, false otherwise.