Jive API (5.0.0.0) Core Javadocs

com.jivesoftware.community
Interface PrivateMessage

All Superinterfaces:
AttachmentContentResource, com.jivesoftware.community.ContainerAware, com.jivesoftware.community.DatedObject, JiveContentObject, JiveObject, com.jivesoftware.community.objecttype.SubjectAware, UserAuthoredObject

public interface PrivateMessage
extends JiveContentObject, AttachmentContentResource

Private messages are used for user to user communication.

See Also:
PrivateMessageFolder, PrivateMessageManager

Nested Class Summary
 
Nested classes/interfaces inherited from interface com.jivesoftware.community.JiveContentObject
JiveContentObject.Field, JiveContentObject.Status
 
Method Summary
 Document getBody()
          Returns the message body.
 Date getDate()
          Returns the date the message was saved or sent, or null if the message hasn't been sent or saved yet.
 PrivateMessageFolder getFolder()
          Returns the folder the private message or null if the message does not yet belong to a folder.
 long getID()
          Returns the id of the message.
 Map<String,String> getProperties()
          Retrieve a map of all the extended properties for the private message.
 User getRecipient()
          Returns the user the message was sent to.
 List getRecipients()
          Returns the list of users the message was sent to.
 User getSender()
          Returns the user the message was sent by, or null if the message was sent by the system.
 String getSubject()
          Returns the message subject.
 String getUnfilteredProperty(String name)
          Returns an extended property of the private message, bypassing any filters.
 String getUnfilteredSubject()
          Returns the message subject, bypassing any active filters.
 boolean isRead()
          Returns true if this message has been marked as read.
 void setBody(Document body)
          Sets the body of the message.
 void setRead(boolean read)
          Marks this message as read or unread.
 void setStatus(JiveContentObject.Status status)
          Sets the Status of the PrivateMessage
 void setSubject(String subject)
          Sets the subject of the message.
 
Methods inherited from interface com.jivesoftware.community.JiveContentObject
getContainerID, getContainerType, getCreationDate, getJiveObjectType, getModificationDate, getPlainBody, getStatus
 
Methods inherited from interface com.jivesoftware.community.UserAuthoredObject
getAuthorIDs, getAuthors, getUser, getUserID
 
Methods inherited from interface com.jivesoftware.community.objecttype.SubjectAware
getPlainSubject
 
Methods inherited from interface com.jivesoftware.community.JiveObject
getObjectType
 

Method Detail

getID

long getID()
Returns the id of the message.

Specified by:
getID in interface JiveObject
Returns:
the unique id of the message.

getDate

Date getDate()
Returns the date the message was saved or sent, or null if the message hasn't been sent or saved yet.

Returns:
the date the message was sent or saaved, or null if not yet sent.

getFolder

PrivateMessageFolder getFolder()
Returns the folder the private message or null if the message does not yet belong to a folder.

Returns:
the folder the message belongs to.

getSubject

String getSubject()
Returns the message subject. If message filters are active, the subject returned will be a filtered one. Because filters often provide security functionality, this method is the preferred way to get the subject of a message.

Specified by:
getSubject in interface com.jivesoftware.community.objecttype.SubjectAware
Returns:
the subject of the message.

getUnfilteredSubject

String getUnfilteredSubject()
Returns the message subject, bypassing any active filters. Because filters often provide security, this method should be used with caution. In particular, you should avoid showing unfiltered data in an environment where embedded HTML might be interpreted.

Unfiltered content is necessary for a few reasons. One is when saving Jive content to another persistence mechanism such as an XML format. Another is when you need to skip filter formatting, such as when a user is responding to another user's message.

Specified by:
getUnfilteredSubject in interface JiveContentObject
Returns:
the subject of the message.

setSubject

void setSubject(String subject)
                throws UnauthorizedException
Sets the subject of the message.

Parameters:
subject - the subject of the message.
Throws:
UnauthorizedException - if not allowed to edit the message.

getBody

Document getBody()
Returns the message body. If message filters are active, the body returned will be a filtered one. Because filters often provide security functionality such as stripping out HTML and Javascript, this method is the preferred way to get the body of a message.

Specified by:
getBody in interface JiveContentObject
Returns:
the body of the message.

setBody

void setBody(Document body)
             throws UnauthorizedException
Sets the body of the message.

Parameters:
body - the body of the message.
Throws:
UnauthorizedException - if does not have ADMIN permissions.

getSender

User getSender()
Returns the user the message was sent by, or null if the message was sent by the system.

Returns:
the user that sent the message.

getRecipient

User getRecipient()
Returns the user the message was sent to.

Returns:
the user the message was sent to.

getRecipients

List getRecipients()
Returns the list of users the message was sent to.

Returns:
the list of users the message was sent to.

isRead

boolean isRead()
Returns true if this message has been marked as read.

Returns:
true if the message is read.

setRead

void setRead(boolean read)
Marks this message as read or unread.

Parameters:
read - true to mark the message as read.

getProperties

Map<String,String> getProperties()
Retrieve a map of all the extended properties for the private message. Each private message can have an arbitrary number of extended properties. This allows for enhanced functionality that is not part of the base interface. The map is alterable if the user is authorized to modify the message. Null keys and values are not allowed.

If the user is not authorized to modify the private message any method which modifies the map will fail with a UnsupportedOperationException;

Returns:
a map of private message extended properties.

getUnfilteredProperty

String getUnfilteredProperty(String name)
Returns an extended property of the private message, bypassing any filters. Each private message can have an arbitrary number of extended properties. This allows for enhanced functionality that is not part of the base interface.

Because properties are not filtered before being returned, this method should be used with caution. In particular, you should avoid showing unfiltered data in an environment where embedded HTML might be interpreted.

Parameters:
name - the name of the property to get.
Returns:
the value of the property.

setStatus

void setStatus(JiveContentObject.Status status)
Sets the Status of the PrivateMessage

Parameters:
status - the status.

Jive Product Page

Copyright © 1999-2007 Jive Software.