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

Interface MessageSocialComponent

All Superinterfaces:

SocialComponent

public interface MessageSocialComponent
extends SocialComponent

Represents a single Social Messaging message.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	MESSAGE_RESOURCE_TYPE Resource type for message.
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_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.

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

DEFAULT_SELECTOR, INDEX_SELECTOR, PROP_REFERER, QUERY_SELECTOR, TRANSLATE_SELECTOR

Method Summary

Modifier and Type	Method and Description
java.util.List<Attachment>	getAttachments() Get message attachments.
java.lang.String	getContent()
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()

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

getAsMap, getFriendlyUrl, getId, getParentComponent, getProperties, 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_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

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

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

Returns:

custom properties.

getSubject

java.lang.String getSubject()

Returns:

message subject.

getContent

java.lang.String getContent()

Returns:

message content.

getTimestamp

java.util.Calendar getTimestamp()

Returns:

message's timestamp.

getMessageBoxRelativePath

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.

getAttachments

java.util.List<Attachment> getAttachments()
                                   throws MessageException

Get message attachments.

Returns:

Attachments.

Throws:

MessageException - MessageException if there is error fetching attachments.

getSender

MessagingUser getSender()

Get message sender.

Returns:

MessagingUser.

getRecipients

java.util.List<MessagingUser> getRecipients()

Get recipients of a message.

Returns:

list of MessagingUser.

getRecipientsNames

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

Get the names of the recipients of a message

Returns:

list of the recipient's names

isRead

boolean isRead()

Returns:

true if message is read, false otherwise.

isDeleted

boolean isDeleted()

Returns:

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

getMessageID

java.lang.String getMessageID()

Returns:

message id.

getMessageBoxPath

java.lang.String getMessageBoxPath()

Returns:

absolute path of this message's message box.