|
Jive Forums API (5.5.20.2-oracle) Developer Javadocs | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface PrivateMessage
Private messages are used for user to user communication.
PrivateMessageFolder
,
PrivateMessageManager
Method Summary | |
---|---|
Attachment |
createAttachment(java.lang.String name,
java.lang.String contentType,
java.io.InputStream data)
Creates a new attachment for this private message. |
void |
deleteAttachment(Attachment attachment)
Deletes an attachment that belongs to this private message. |
void |
deleteProperty(java.lang.String name)
Deletes an extended property. |
int |
getAttachmentCount()
Returns the number of attachments this private message has. |
java.util.Iterator |
getAttachments()
Returns an Iterator for all attachments of this private message. |
java.lang.String |
getBody()
Returns the message body. |
java.util.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. |
java.util.Collection |
getProperties(java.lang.String parentName)
Return all immediate children property values of a parent property as an unmodifiable Collection of String values. |
java.lang.String |
getProperty(java.lang.String name)
Returns an extended property of this private message. |
java.util.Iterator |
getPropertyNames()
Returns an Iterator of String values for all the names of the message properties. |
User |
getRecipient()
Returns the user 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. |
java.lang.String |
getSubject()
Returns the message subject. |
java.lang.String |
getUnfilteredBody()
Returns the message body, bypassing any active filters. |
java.lang.String |
getUnfilteredProperty(java.lang.String name)
Returns an extended property of this private message, bypassing any filters. |
java.lang.String |
getUnfilteredSubject()
Returns the message subject, bypassing any active filters. |
boolean |
isAuthorized(long permissionType)
Returns true if the handle on this object has the permission specified. |
boolean |
isRead()
Returns true if this message has been marked as read. |
void |
setBody(java.lang.String body)
Sets the body of the message. |
void |
setProperty(java.lang.String name,
java.lang.String value)
Sets an extended property of this private message. |
void |
setRead(boolean read)
Marks this message as read or unread. |
void |
setSubject(java.lang.String subject)
Sets the subject of the message. |
Method Detail |
---|
long getID()
java.util.Date getDate()
PrivateMessageFolder getFolder()
java.lang.String getSubject()
java.lang.String getUnfilteredSubject()
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.
void setSubject(java.lang.String subject) throws UnauthorizedException
subject
- the subject of the message.
UnauthorizedException
- if not allowed to edit the message.java.lang.String getBody()
java.lang.String getUnfilteredBody()
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.
void setBody(java.lang.String body) throws UnauthorizedException
body
- the body of the message.
UnauthorizedException
- if does not have ADMIN permissions.User getSender()
User getRecipient()
boolean isRead()
void setRead(boolean read)
read
- true to mark the message as read.Attachment createAttachment(java.lang.String name, java.lang.String contentType, java.io.InputStream data) throws java.lang.IllegalStateException, AttachmentException, UnauthorizedException
name
- the name of the new attachment, usually the file name.contentType
- the content type of the attachment.data
- an InputStream that contains the binary data of the
attachment. The stream will never be closed so you must
close it manually after calling this method.
AttachmentException
- if an error occured while creating the
attachment. Errors can occur because the attachment is too large or
because the private message already has too many attachments.
UnauthorizedException
- if not allowed to create attachments.
java.lang.IllegalStateException
Attachment
,
AttachmentManager
int getAttachmentCount()
java.util.Iterator getAttachments()
Attachment
void deleteAttachment(Attachment attachment) throws AttachmentException, UnauthorizedException
attachment
- the attachment to delete.
java.lang.IllegalArgumentException
- if the attachment doesn't belong to
this message.
UnauthorizedException
- if not authorized to delete the attachment.
AttachmentException
- if there was an error deleting the attachment.java.lang.String getProperty(java.lang.String name)
For security reasons, you should enable an HTML filter in case properties contain malicious HTML code.
name
- the name of the property to get.
java.util.Collection getProperties(java.lang.String parentName)
parentName
- the name of the parent property to return the children for.
java.lang.String getUnfilteredProperty(java.lang.String name)
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.
name
- the name of the property to get.
void setProperty(java.lang.String name, java.lang.String value) throws UnauthorizedException
name
- the name of the property to set.value
- the new value for the property.
UnauthorizedException
- if not allowed to edit the message.void deleteProperty(java.lang.String name) throws UnauthorizedException
name
does not exist, this method will do nothing.
name
- the name of the property to delete.
UnauthorizedException
- if not allowed to edit the message.java.util.Iterator getPropertyNames()
boolean isAuthorized(long permissionType)
A list of possible permissions can be found in the ForumPermissions class. Certain methods of this class are restricted to certain permissions as specified in the method comments.
permissionType
- permissionType a permission type.
ForumPermissions
|
Jive Forums Project Page | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |