|
Jive Forums API (5.5.20.2-oracle) Core Javadocs | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface PrivateMessageFolder
Holds private messages. Every user has four built-in folders and a number of custom folders. The built-in folders are:
INBOX
-- the user's inbox.
SENT
-- messages the user has sent.
DRAFTS
-- draft messages.
TRASH
-- messages awaiting permanent deletion.
PrivateMessageManager
,
PrivateMessage
Field Summary | |
---|---|
static int |
FOLDER_DRAFTS
|
static int |
FOLDER_INBOX
|
static int |
FOLDER_SENT
|
static int |
FOLDER_TRASH
|
static int |
SORT_DATE
|
static int |
SORT_SENDER
|
static int |
SORT_SUBJECT
|
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. |
Field Detail |
---|
static final int FOLDER_INBOX
static final int FOLDER_SENT
static final int FOLDER_DRAFTS
static final int FOLDER_TRASH
static final int SORT_DATE
static final int SORT_SUBJECT
static final int SORT_SENDER
Method Detail |
---|
int getID()
User getOwner()
java.lang.String getName()
void setName(java.lang.String name)
name
- the new name for the folder.java.util.Iterator getMessages()
java.util.Iterator getMessages(int startIndex, int count, int sortField, boolean sortDescending)
INBOX
-- the user's inbox.
SORT_DATE
-- sort messages by date.
SORT_SENDER
-- sort messages by sender.
SORT_SUBJECT
-- sort messages by subject.
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.
int getMessageCount()
int getUnreadMessageCount()
void deleteMessage(PrivateMessage privateMessage)
privateMessage
- the private message to delete.void moveMessage(PrivateMessage privateMessage, PrivateMessageFolder destinationFolder)
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 |