|
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.webservices.server.PrivateMessageServiceImpl
public class PrivateMessageServiceImpl
Constructor Summary | |
---|---|
PrivateMessageServiceImpl()
|
Method Summary | |
---|---|
PrivateMessageFolder |
createFolder(long userID,
java.lang.String name)
Create a named folder for the specified user. |
PrivateMessage |
createMessage(long senderID)
Creates a new private message. |
void |
deleteFolder(long userID,
int folderID)
Delete the specified folder id for a user. |
void |
deleteMessage(long userID,
long messageID)
Deletes a private message from the folder by moving it to the trash folder. |
PrivateMessageFolder |
getFolder(long userID,
int folderID)
Returns the specified folder for a user. |
PrivateMessageFolder[] |
getFolders(long userID)
Returns an array of Private Message folders for a specified user. |
PrivateMessage |
getMessage(long privateMessageID)
Returns the specified private message. |
int |
getMessageCount(long userID)
Returns the total message count for a specified user. |
int |
getMessageCountForFolder(long userID,
int folderID)
Returns the message count on a specific folder. |
PrivateMessage[] |
getMessages(long userID,
int folderID)
Returns all the messages in the folder sorted by date descending. |
int |
getUnreadMessageCount(long userID)
Returns the total number of unread messages for a user. |
int |
getUnreadMessageCountForFolder(long userID,
int folderID)
Returns the unread message count for a specified folder. |
boolean |
isPrivateMessagesEnabled()
Returns whether or not Private Messaging is enabled or disabled. |
void |
moveMessage(long userID,
long messageID,
int destinationFolderID)
Moves a private message to another folder. |
void |
saveMessageAsDraft(PrivateMessage privateMessage)
Saves a message as a draft by storing it in the sender's Drafts folder. |
PrivateMessage |
sendMessage(PrivateMessage privateMessage,
long recipientID,
boolean copyToSentFolder)
Sends a private message to another user. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public PrivateMessageServiceImpl()
Method Detail |
---|
public boolean isPrivateMessagesEnabled()
isPrivateMessagesEnabled
in interface PrivateMessageService
public PrivateMessage[] getMessages(long userID, int folderID) throws UserNotFoundException, PrivateMessageFolderNotFoundException
PrivateMessageService
getMessages
in interface PrivateMessageService
userID
- folderID
-
UserNotFoundException
PrivateMessageFolderNotFoundException
public void deleteMessage(long userID, long messageID) throws UserNotFoundException, PrivateMessageFolderNotFoundException, PrivateMessageNotFoundException
PrivateMessageService
deleteMessage
in interface PrivateMessageService
userID
- messageID
-
UserNotFoundException
PrivateMessageFolderNotFoundException
PrivateMessageNotFoundException
public void moveMessage(long userID, long messageID, int destinationFolderID) throws UserNotFoundException, PrivateMessageFolderNotFoundException, PrivateMessageNotFoundException
PrivateMessageService
moveMessage
in interface PrivateMessageService
userID
- messageID
- destinationFolderID
-
UserNotFoundException
PrivateMessageFolderNotFoundException
PrivateMessageNotFoundException
public int getMessageCount(long userID) throws UnauthorizedException, UserNotFoundException
getMessageCount
in interface PrivateMessageService
userID
-
UnauthorizedException
UserNotFoundException
public int getMessageCountForFolder(long userID, int folderID) throws UnauthorizedException, UserNotFoundException, PrivateMessageFolderNotFoundException
PrivateMessageService
getMessageCountForFolder
in interface PrivateMessageService
userID
- folderID
-
UnauthorizedException
UserNotFoundException
PrivateMessageFolderNotFoundException
public int getUnreadMessageCount(long userID) throws UnauthorizedException, UserNotFoundException
getUnreadMessageCount
in interface PrivateMessageService
userID
-
UnauthorizedException
UserNotFoundException
public int getUnreadMessageCountForFolder(long userID, int folderID) throws UnauthorizedException, UserNotFoundException, PrivateMessageFolderNotFoundException
getUnreadMessageCountForFolder
in interface PrivateMessageService
userID
- folderID
-
UnauthorizedException
UserNotFoundException
PrivateMessageFolderNotFoundException
public PrivateMessageFolder[] getFolders(long userID) throws UnauthorizedException, UserNotFoundException
getFolders
in interface PrivateMessageService
userID
-
UnauthorizedException
UserNotFoundException
public PrivateMessageFolder getFolder(long userID, int folderID) throws PrivateMessageFolderNotFoundException, UnauthorizedException, UserNotFoundException
getFolder
in interface PrivateMessageService
userID
- folderID
-
PrivateMessageFolderNotFoundException
UnauthorizedException
UserNotFoundException
public PrivateMessageFolder createFolder(long userID, java.lang.String name) throws UnauthorizedException, UserNotFoundException
createFolder
in interface PrivateMessageService
userID
- name
-
UnauthorizedException
UserNotFoundException
public void deleteFolder(long userID, int folderID) throws UnauthorizedException, UserNotFoundException, PrivateMessageFolderNotFoundException
deleteFolder
in interface PrivateMessageService
userID
- folderID
-
UnauthorizedException
UserNotFoundException
PrivateMessageFolderNotFoundException
public PrivateMessage getMessage(long privateMessageID) throws UnauthorizedException, PrivateMessageNotFoundException
getMessage
in interface PrivateMessageService
privateMessageID
-
UnauthorizedException
PrivateMessageNotFoundException
public PrivateMessage createMessage(long senderID) throws UnauthorizedException, UserNotFoundException
createMessage
in interface PrivateMessageService
senderID
-
UnauthorizedException
UserNotFoundException
public void saveMessageAsDraft(PrivateMessage privateMessage) throws UnauthorizedException, PrivateMessageRejectedException, UserNotFoundException
saveMessageAsDraft
in interface PrivateMessageService
privateMessage
-
UnauthorizedException
PrivateMessageRejectedException
UserNotFoundException
public PrivateMessage sendMessage(PrivateMessage privateMessage, long recipientID, boolean copyToSentFolder) throws UnauthorizedException, PrivateMessageRejectedException, UserNotFoundException
PrivateMessageRejectedException
will be thrown. The exception will also be thrown if the recipient is not allowed
to receive private messages or if the user has elected to save a copy of the message in
their Sent folder, but doesn't have room to do so.
sendMessage
in interface PrivateMessageService
privateMessage
- recipientID
- copyToSentFolder
-
UnauthorizedException
PrivateMessageRejectedException
UserNotFoundException
|
Jive Forums Project Page | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |