|
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 |
java.lang.Objectcom.jivesoftware.forum.proxy.PrivateMessageFolderProxy
public class PrivateMessageFolderProxy
Proxy class for PrivateMessageFolder objects.
Field Summary |
---|
Fields inherited from interface com.jivesoftware.forum.PrivateMessageFolder |
---|
FOLDER_DRAFTS, FOLDER_INBOX, FOLDER_SENT, FOLDER_TRASH, SORT_DATE, SORT_SENDER, SORT_SUBJECT |
Constructor Summary | |
---|---|
PrivateMessageFolderProxy(PrivateMessageFolder folder,
AuthToken authToken)
Creates a new PrivateMessageFolderProxy to protect the supplied message with the specified permissions. |
Method Summary | |
---|---|
void |
deleteMessage(PrivateMessage privateMessage)
Deletes a private message from the folder by moving it to the trash folder. |
int |
getID()
Returns the ID of the folder. |
int |
getMessageCount()
Returns the number of messages in the folder. |
java.util.Iterator |
getMessages()
Returns all the messages in the folder sorted by date descending. |
java.util.Iterator |
getMessages(int startIndex,
int count,
int sortField,
boolean sortDescending)
Returns messages in the folder based on the params. |
java.lang.String |
getName()
Returns the name of the folder. |
User |
getOwner()
Returns the owner of the private message folder. |
int |
getUnreadMessageCount()
Returns the number of unread messages in the folder. |
void |
moveMessage(PrivateMessage privateMessage,
PrivateMessageFolder destinationFolder)
Moves a private message to another folder. |
void |
setName(java.lang.String name)
Sets the name of the folder. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public PrivateMessageFolderProxy(PrivateMessageFolder folder, AuthToken authToken)
Method Detail |
---|
public int getID()
PrivateMessageFolder
getID
in interface PrivateMessageFolder
public User getOwner()
PrivateMessageFolder
getOwner
in interface PrivateMessageFolder
public java.lang.String getName()
PrivateMessageFolder
getName
in interface PrivateMessageFolder
public void setName(java.lang.String name)
PrivateMessageFolder
setName
in interface PrivateMessageFolder
name
- the new name for the folder.public java.util.Iterator getMessages()
PrivateMessageFolder
getMessages
in interface PrivateMessageFolder
public java.util.Iterator getMessages(int startIndex, int count, int sortField, boolean sortDescending)
PrivateMessageFolder
INBOX
-- the user's inbox.
PrivateMessageFolder.SORT_DATE
-- sort messages by date.
PrivateMessageFolder.SORT_SENDER
-- sort messages by sender.
PrivateMessageFolder.SORT_SUBJECT
-- sort messages by subject.
getMessages
in interface PrivateMessageFolder
startIndex
- the start index of messages to return (0 starts at the beginning).count
- the number of messages to return.sortField
- the filed to sort on.sortDescending
- true if the messages should be sorted in descending order.
For example, if the sort field is date and sortDescending is true, messages will
be returned newest to oldest.
public int getMessageCount()
PrivateMessageFolder
getMessageCount
in interface PrivateMessageFolder
public int getUnreadMessageCount()
PrivateMessageFolder
getUnreadMessageCount
in interface PrivateMessageFolder
public void deleteMessage(PrivateMessage privateMessage)
PrivateMessageFolder
deleteMessage
in interface PrivateMessageFolder
privateMessage
- the private message to delete.public void moveMessage(PrivateMessage privateMessage, PrivateMessageFolder destinationFolder)
PrivateMessageFolder
moveMessage
in interface PrivateMessageFolder
privateMessage
- the message to move.destinationFolder
- the folder to move the message to.
|
Jive Forums Project Page | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |