|
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.moderation.ModerationManagerImpl
public class ModerationManagerImpl
Field Summary |
---|
Fields inherited from interface com.jivesoftware.forum.moderation.ModerationManager |
---|
PROPERTY_EMAIL_ADDRESS, PROPERTY_EMAIL_BODY_HTML, PROPERTY_EMAIL_BODY_TEXT, PROPERTY_EMAIL_ENABLED, PROPERTY_EMAIL_NAME, PROPERTY_EMAIL_SUBJECT, PROPERTY_MESSAGE_TIME_APPROVED |
Method Summary | |
---|---|
void |
approve(AuthToken authToken,
ForumMessage message)
Approve a moderated message |
void |
editAndApprove(AuthToken authToken,
ForumMessage message,
java.lang.String subject,
java.lang.String body)
Edit and approve a moderated message |
java.lang.String |
getEmailAddress()
Gets the email address that moderation email alerts will appear to be from |
java.lang.String |
getEmailBodyHtml(java.util.Locale locale)
Gets the html body of moderation email alerts. |
java.lang.String |
getEmailBodyText(java.util.Locale locale)
Gets the plain text body of moderation email alerts. |
java.lang.String |
getEmailName()
Gets the name that moderation email alerts will appear to be from |
java.lang.String |
getEmailSubject(java.util.Locale locale)
Gets the text for the subject of moderation email alerts. |
java.util.List |
getForums(AuthToken authToken)
This method will return a list of forums where the user is a moderator. |
static ModerationManager |
getInstance()
|
int |
getMessageCount(Forum forum)
Gets the number of moderated messages in a forum |
int |
getMessageCount(ModerationFilter modFilter,
AuthToken authToken)
Gets the number of moderated messages in the system |
int |
getMessageCount(ModerationFilter modFilter,
Forum forum)
Gets the number of moderated messages in a forum |
java.util.List |
getMessages(AuthToken authToken)
This method will return a list of messages where the user is a moderator. |
ForumMessageIterator |
getMessages(AuthToken authToken,
Forum forum)
Gets a list of moderated messages for a particular forum. |
java.util.List |
getMessages(ModerationFilter modFilter,
AuthToken authToken)
This method will return a list of messages where the user is a moderator. |
ForumMessageIterator |
getMessages(ModerationFilter modFilter,
AuthToken authToken,
Forum forum)
Gets a list of moderated messages for a particular forum. |
boolean |
isEmailAlertEnabled()
Returns true if moderation email alerts enabled. |
void |
reject(AuthToken authToken,
ForumMessage message)
Reject a moderated message |
void |
setEmailAddress(java.lang.String emailAddress)
Sets the email address that moderation email alerts will appear to be from |
void |
setEmailAlertEnabled(boolean emailAlertEnabled)
Enables or disables moderation email alerts. |
void |
setEmailBodyHtml(java.lang.String emailBodyHtml,
java.util.Locale locale)
The html body of moderation email alerts. |
void |
setEmailBodyText(java.lang.String emailBodyText,
java.util.Locale locale)
Sets the plain text body of moderation email alerts. |
void |
setEmailName(java.lang.String emailName)
Sets The name that moderation email alerts will appear to be from |
void |
setEmailSubject(java.lang.String emailSubject,
java.util.Locale locale)
Sets the text for the subject of moderation email alerts. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Method Detail |
---|
public static ModerationManager getInstance()
public java.util.List getForums(AuthToken authToken)
ModerationManager
getForums
in interface ModerationManager
authToken
- the users authTokenpublic java.util.List getMessages(AuthToken authToken)
ModerationManager
getMessages
in interface ModerationManager
authToken
- the users authTokenpublic java.util.List getMessages(ModerationFilter modFilter, AuthToken authToken)
ModerationManager
getMessages
in interface ModerationManager
modFilter
- the moderation filterauthToken
- the users authTokenpublic ForumMessageIterator getMessages(AuthToken authToken, Forum forum) throws UnauthorizedException
ModerationManager
getMessages
in interface ModerationManager
authToken
- the users authTokenforum
- the forum to scan
UnauthorizedException
- if the user is not a moderator of the forumpublic ForumMessageIterator getMessages(ModerationFilter modFilter, AuthToken authToken, Forum forum) throws UnauthorizedException
ModerationManager
getMessages
in interface ModerationManager
modFilter
- the moderation filterauthToken
- the users authTokenforum
- the forum to scan
UnauthorizedException
- if the user is not a moderator of the forumpublic int getMessageCount(ModerationFilter modFilter, AuthToken authToken)
ModerationManager
getMessageCount
in interface ModerationManager
modFilter
- the moderation filterauthToken
- the users authToken
public int getMessageCount(Forum forum)
ModerationManager
getMessageCount
in interface ModerationManager
forum
- the forum to scan
public int getMessageCount(ModerationFilter modFilter, Forum forum)
ModerationManager
getMessageCount
in interface ModerationManager
modFilter
- the moderation filterforum
- the forum to scan
public void approve(AuthToken authToken, ForumMessage message) throws UnauthorizedException
ModerationManager
approve
in interface ModerationManager
authToken
- the users authTokenmessage
- the message to approve
UnauthorizedException
- if the user is not a moderator of the forum in which the message belongspublic void editAndApprove(AuthToken authToken, ForumMessage message, java.lang.String subject, java.lang.String body) throws UnauthorizedException, MessageRejectedException
ModerationManager
editAndApprove
in interface ModerationManager
authToken
- the users authTokenmessage
- the message to edit and approvesubject
- the new message subjectbody
- the new message body
UnauthorizedException
- if the user is not a moderator of the forum in which the message belongs
MessageRejectedException
public void reject(AuthToken authToken, ForumMessage message) throws UnauthorizedException
ModerationManager
reject
in interface ModerationManager
authToken
- the users authTokenmessage
- the message to reject
UnauthorizedException
- if the user is not a moderator of the forum in which the message belongspublic boolean isEmailAlertEnabled()
ModerationManager
isEmailAlertEnabled
in interface ModerationManager
public void setEmailAlertEnabled(boolean emailAlertEnabled)
ModerationManager
setEmailAlertEnabled
in interface ModerationManager
emailAlertEnabled
- true to enable the email alert feature, false to disable.public java.lang.String getEmailName()
ModerationManager
getEmailName
in interface ModerationManager
public void setEmailName(java.lang.String emailName)
ModerationManager
setEmailName
in interface ModerationManager
emailName
- the name that moderation email alerts will appear to be frompublic java.lang.String getEmailAddress()
ModerationManager
getEmailAddress
in interface ModerationManager
public void setEmailAddress(java.lang.String emailAddress)
ModerationManager
setEmailAddress
in interface ModerationManager
emailAddress
- the email address that moderation email alerts will appear to be frompublic java.lang.String getEmailSubject(java.util.Locale locale)
ModerationManager
getEmailSubject
in interface ModerationManager
public void setEmailSubject(java.lang.String emailSubject, java.util.Locale locale)
ModerationManager
setEmailSubject
in interface ModerationManager
emailSubject
- the text for the subject of moderation email alertspublic java.lang.String getEmailBodyText(java.util.Locale locale)
ModerationManager
getEmailBodyText
in interface ModerationManager
public void setEmailBodyText(java.lang.String emailBodyText, java.util.Locale locale)
ModerationManager
setEmailBodyText
in interface ModerationManager
emailBodyText
- the plain text body of the moderation email alerts.public java.lang.String getEmailBodyHtml(java.util.Locale locale)
ModerationManager
getEmailBodyHtml
in interface ModerationManager
public void setEmailBodyHtml(java.lang.String emailBodyHtml, java.util.Locale locale)
ModerationManager
setEmailBodyHtml
in interface ModerationManager
emailBodyHtml
- the html body of the moderation email alerts.
|
Jive Forums Project Page | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |