|
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.PrivateMessageManagerProxy
public class PrivateMessageManagerProxy
Proxy class for PrivateMessageManager objects.
Constructor Summary | |
---|---|
PrivateMessageManagerProxy(PrivateMessageManager manager,
AuthToken authToken,
Permissions permissions)
Creates a new PrivateMessageManagerProxy to protect the supplied message with the specified permissions. |
Method Summary | |
---|---|
PrivateMessageFolder |
createFolder(User user,
java.lang.String name)
Creates a new folder. |
PrivateMessage |
createMessage(User sender)
Creates a new private message. |
void |
deleteFolder(PrivateMessageFolder folder)
Deletes a folder. |
PrivateMessageFolder |
getFolder(User user,
int folderID)
Returns the specified folder for a user. |
int |
getFolderCount(User user)
Returns the total number of folders the user has. |
java.util.Iterator |
getFolders(User user)
Returns an Iterator of PrivateMessageFolder objects for the folders the user has. |
int |
getMaxMessagesPerUser()
Returns the max number of messages each user is allowed to store in their mailbox, or -1 if there is no limit. |
PrivateMessage |
getMessage(long privateMessageID)
Returns the specified private message. |
int |
getMessageCount(User user)
Returns the total number of private messages a user has in their mailbox. |
RenderManager |
getRenderManager()
Returns a render manager for private messages in the system. |
int |
getUnreadMessageCount(User user)
Returns the total number of unread private messages a user has in their mailbox. |
boolean |
isPrivateMessagesEnabled()
Returns true if the feature is enabled, false otherwise. |
void |
saveMessageAsDraft(PrivateMessage privateMessage)
Saves a message as a draft by storing it in the sender's Drafts folder. |
PrivateMessage |
sendMessage(PrivateMessage privateMessage,
User recipient,
boolean copyToSentFolder)
Sends a private message to another user. |
void |
setMaxMessagesPerUser(int maxMessages)
Sets the max number of message is allowed to store in their mailbox. |
void |
setPrivateMessagesEnabled(boolean enabled)
Enables or disables the private message feature. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public PrivateMessageManagerProxy(PrivateMessageManager manager, AuthToken authToken, Permissions permissions)
Method Detail |
---|
public boolean isPrivateMessagesEnabled()
PrivateMessageManager
isPrivateMessagesEnabled
in interface PrivateMessageManager
public void setPrivateMessagesEnabled(boolean enabled) throws UnauthorizedException
PrivateMessageManager
setPrivateMessagesEnabled
in interface PrivateMessageManager
enabled
- true to enable PM's, false otherwise.
UnauthorizedException
public RenderManager getRenderManager()
PrivateMessageManager
getRenderManager
in interface PrivateMessageManager
public int getMaxMessagesPerUser()
PrivateMessageManager
getMaxMessagesPerUser
in interface PrivateMessageManager
public void setMaxMessagesPerUser(int maxMessages) throws UnauthorizedException
PrivateMessageManager
setMaxMessagesPerUser
in interface PrivateMessageManager
maxMessages
- the max number of messages a user is allowed to store in their
mailbox, or -1 for no limit.
UnauthorizedException
- if not a system administrator.public int getMessageCount(User user) throws UnauthorizedException
PrivateMessageManager
getMessageCount
in interface PrivateMessageManager
user
- the user.
UnauthorizedException
- if not an administrator or the user.public int getUnreadMessageCount(User user) throws UnauthorizedException
PrivateMessageManager
getUnreadMessageCount
in interface PrivateMessageManager
user
- the user.
UnauthorizedException
- if not an administrator or the user.public int getFolderCount(User user) throws UnauthorizedException
PrivateMessageManager
getFolderCount
in interface PrivateMessageManager
user
- the user.
UnauthorizedException
- if not an administrator or the user.public java.util.Iterator getFolders(User user) throws UnauthorizedException
PrivateMessageManager
getFolders
in interface PrivateMessageManager
user
- the user.
UnauthorizedException
- if not an administrator or the user.public PrivateMessageFolder getFolder(User user, int folderID) throws PrivateMessageFolderNotFoundException, UnauthorizedException
PrivateMessageManager
getFolder
in interface PrivateMessageManager
user
- the user.folderID
- the folder ID.
PrivateMessageFolderNotFoundException
- if the folder could not be loaded.
UnauthorizedException
- if not an administrator or the user.public PrivateMessageFolder createFolder(User user, java.lang.String name) throws UnauthorizedException
PrivateMessageManager
createFolder
in interface PrivateMessageManager
user
- the user to create the folder for.name
- the name of the folder.
UnauthorizedException
- if not an administrator or the user.public void deleteFolder(PrivateMessageFolder folder) throws UnauthorizedException
PrivateMessageManager
deleteFolder
in interface PrivateMessageManager
folder
- the folder to delete.
UnauthorizedException
- if not an administrator or the user.public PrivateMessage getMessage(long privateMessageID) throws UnauthorizedException, PrivateMessageNotFoundException
PrivateMessageManager
getMessage
in interface PrivateMessageManager
privateMessageID
- the ID of the private message.
UnauthorizedException
- if not an administrator or the user.
PrivateMessageNotFoundException
- if the message could not be loaded.public PrivateMessage createMessage(User sender) throws UnauthorizedException
PrivateMessageManager
createMessage
in interface PrivateMessageManager
sender
- the user sending the message.
UnauthorizedException
- if not an administrator or the user.public void saveMessageAsDraft(PrivateMessage privateMessage) throws UnauthorizedException, PrivateMessageRejectedException
PrivateMessageManager
saveMessageAsDraft
in interface PrivateMessageManager
privateMessage
- the message to save.
UnauthorizedException
- if not an administrator or the user.
PrivateMessageRejectedException
- if the message could not be saved as a
draft.public PrivateMessage sendMessage(PrivateMessage privateMessage, User recipient, boolean copyToSentFolder) throws UnauthorizedException, PrivateMessageRejectedException
PrivateMessageManager
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 PrivateMessageManager
privateMessage
- the message to send.recipient
- the user to send the message to.copyToSentFolder
- true if the message should be copied to the Sent folder.
UnauthorizedException
- if not allowed to send the message.
PrivateMessageRejectedException
- if the message could not be delivered.
|
Jive Forums Project Page | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |