com.adobe.cq.social.messaging.api

Interface Message

All Superinterfaces:

Adaptable

Deprecated.

@since AEM 6.1. Use MessageSocialComponent instead.

@Deprecated
public interface Message
extends Adaptable

Message interface.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	NT_MESSAGE_NODE_TYPE Deprecated. node type for message Nodes.
static java.lang.String	PN_MESSAGE_CONTENT Deprecated. property to specify message content.
static java.lang.String	PN_MESSAGE_DELETED Deprecated. property to specify trashed or not.
static java.lang.String	PN_MESSAGE_ID Deprecated. property to specify message id.
static java.lang.String	PN_MESSAGE_READ Deprecated. property to specify to specify read or unread.
static java.lang.String	PN_MESSAGE_RECIPIENT_NAMES Deprecated. property to specify recipients' names.
static java.lang.String	PN_MESSAGE_RECIPIENTS Deprecated. property to specify recipients.
static java.lang.String	PN_MESSAGE_SENDER Deprecated. property to specify sender id.
static java.lang.String	PN_MESSAGE_SENDER_NAME Deprecated. property to specify sender name.
static java.lang.String	PN_MESSAGE_SIZE Deprecated. property name for size of message.
static java.lang.String	PN_MESSAGE_SUBJECT Deprecated. property to specify message subject.
static java.lang.String	PN_MESSAGE_TIMESTAMP Deprecated. property to specify time stamp of message.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getContent() Deprecated. get content of message.
java.lang.Object	getCustomProperty(java.lang.String propertyName) Deprecated. get a custom property stored on message.
java.lang.String	getId() Deprecated. get message id.
java.util.List<java.lang.String>	getRecipientIdList() Deprecated. get list of ids of recipients.
java.util.List<java.lang.String>	getRecipientNameList() Deprecated. get list of recipient names.
java.lang.String	getSenderId() Deprecated. get id of sender.
java.lang.String	getSenderName() Deprecated. get name of sender.
java.lang.String	getSubject() Deprecated. get subject of message.
java.util.Calendar	getTimestamp() Deprecated. time at which message had been sent.
boolean	isDeleted() Deprecated. tells if the message has been trashed.
boolean	isRead() Deprecated. tells if message has been read.
java.lang.Object	setCustomProperty(java.lang.String name, java.lang.Object value) Deprecated. change the value of an existing custom property on message.
boolean	setDeleted(boolean value) Deprecated. mark the message as trashed or un-trashed.
boolean	setRead(boolean value) Deprecated. mark the message as read or unread.

Methods inherited from interface org.apache.sling.api.adapter.Adaptable

adaptTo

Field Detail

PN_MESSAGE_ID

static final java.lang.String PN_MESSAGE_ID

Deprecated.

property to specify message id.

See Also:

Constant Field Values

PN_MESSAGE_RECIPIENTS

static final java.lang.String PN_MESSAGE_RECIPIENTS

Deprecated.

property to specify recipients.

See Also:

Constant Field Values

PN_MESSAGE_SENDER_NAME

static final java.lang.String PN_MESSAGE_SENDER_NAME

Deprecated.

property to specify sender name.

See Also:

Constant Field Values

PN_MESSAGE_RECIPIENT_NAMES

static final java.lang.String PN_MESSAGE_RECIPIENT_NAMES

Deprecated.

property to specify recipients' names.

See Also:

Constant Field Values

PN_MESSAGE_SUBJECT

static final java.lang.String PN_MESSAGE_SUBJECT

Deprecated.

property to specify message subject.

See Also:

Constant Field Values

PN_MESSAGE_CONTENT

static final java.lang.String PN_MESSAGE_CONTENT

Deprecated.

property to specify message content.

See Also:

Constant Field Values

PN_MESSAGE_SENDER

static final java.lang.String PN_MESSAGE_SENDER

Deprecated.

property to specify sender id.

See Also:

Constant Field Values

PN_MESSAGE_READ

static final java.lang.String PN_MESSAGE_READ

Deprecated.

property to specify to specify read or unread.

See Also:

Constant Field Values

PN_MESSAGE_DELETED

static final java.lang.String PN_MESSAGE_DELETED

Deprecated.

property to specify trashed or not.

See Also:

Constant Field Values

PN_MESSAGE_TIMESTAMP

static final java.lang.String PN_MESSAGE_TIMESTAMP

Deprecated.

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

Deprecated.

node type for message Nodes.

See Also:

Constant Field Values

PN_MESSAGE_SIZE

static final java.lang.String PN_MESSAGE_SIZE

Deprecated.

property name for size of message.

See Also:

Constant Field Values

Method Detail

getId

java.lang.String getId()

Deprecated.

get message id.

Returns:

id of message.

getSenderId

java.lang.String getSenderId()

Deprecated.

get id of sender.

Returns:

sender id.

getSenderName

java.lang.String getSenderName()

Deprecated.

get name of sender.

Returns:

sender name

getSubject

java.lang.String getSubject()

Deprecated.

get subject of message.

Returns:

subject of message.

getContent

java.lang.String getContent()

Deprecated.

get content of message.

Returns:

content of message.

getRecipientIdList

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

Deprecated.

get list of ids of recipients.

Returns:

list of ids of recipients

getRecipientNameList

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

Deprecated.

get list of recipient names.

Returns:

list of recipient names.

getCustomProperty

java.lang.Object getCustomProperty(java.lang.String propertyName)

Deprecated.

get a custom property stored on message.

Parameters:

propertyName - name of property to be searched for

Returns:

value of a custom property

isRead

boolean isRead()

Deprecated.

tells if message has been read.

Returns:

true for read message.

isDeleted

boolean isDeleted()

Deprecated.

tells if the message has been trashed.

Returns:

true for trashed message.

getTimestamp

java.util.Calendar getTimestamp()

Deprecated.

time at which message had been sent.

Returns:

message sending time.

setDeleted

boolean setDeleted(boolean value)

Deprecated.

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)

Deprecated.

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.

setCustomProperty

java.lang.Object setCustomProperty(java.lang.String name,
                                   java.lang.Object value)

Deprecated.

change the value of an existing custom property on message.

Parameters:

name - name of property

value - value to be set

Returns:

old value of the property if successful. null if the property is not an existing custom property of the message and hence could not be set.