|
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 |
public interface ModerationManager
Field Summary | |
---|---|
static java.lang.String |
PROPERTY_EMAIL_ADDRESS
|
static java.lang.String |
PROPERTY_EMAIL_BODY_HTML
|
static java.lang.String |
PROPERTY_EMAIL_BODY_TEXT
|
static java.lang.String |
PROPERTY_EMAIL_ENABLED
|
static java.lang.String |
PROPERTY_EMAIL_NAME
|
static java.lang.String |
PROPERTY_EMAIL_SUBJECT
|
static java.lang.String |
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. |
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. |
Field Detail |
---|
static final java.lang.String PROPERTY_EMAIL_ENABLED
static final java.lang.String PROPERTY_EMAIL_NAME
static final java.lang.String PROPERTY_EMAIL_ADDRESS
static final java.lang.String PROPERTY_EMAIL_SUBJECT
static final java.lang.String PROPERTY_EMAIL_BODY_TEXT
static final java.lang.String PROPERTY_EMAIL_BODY_HTML
static final java.lang.String PROPERTY_MESSAGE_TIME_APPROVED
Method Detail |
---|
java.util.List getForums(AuthToken authToken)
authToken
- the users authTokenjava.util.List getMessages(AuthToken authToken)
authToken
- the users authTokenjava.util.List getMessages(ModerationFilter modFilter, AuthToken authToken)
modFilter
- the moderation filterauthToken
- the users authTokenForumMessageIterator getMessages(AuthToken authToken, Forum forum) throws UnauthorizedException
authToken
- the users authTokenforum
- the forum to scan
UnauthorizedException
- if the user is not a moderator of the forumForumMessageIterator getMessages(ModerationFilter modFilter, AuthToken authToken, Forum forum) throws UnauthorizedException
modFilter
- the moderation filterauthToken
- the users authTokenforum
- the forum to scan
UnauthorizedException
- if the user is not a moderator of the forumint getMessageCount(ModerationFilter modFilter, AuthToken authToken)
modFilter
- the moderation filterauthToken
- the users authToken
int getMessageCount(Forum forum)
forum
- the forum to scan
int getMessageCount(ModerationFilter modFilter, Forum forum)
modFilter
- the moderation filterforum
- the forum to scan
void approve(AuthToken authToken, ForumMessage message) throws UnauthorizedException
authToken
- the users authTokenmessage
- the message to approve
UnauthorizedException
- if the user is not a moderator of the forum in which the message belongsvoid editAndApprove(AuthToken authToken, ForumMessage message, java.lang.String subject, java.lang.String body) throws UnauthorizedException, MessageRejectedException
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
void reject(AuthToken authToken, ForumMessage message) throws UnauthorizedException
authToken
- the users authTokenmessage
- the message to reject
UnauthorizedException
- if the user is not a moderator of the forum in which the message belongsboolean isEmailAlertEnabled()
void setEmailAlertEnabled(boolean emailAlertEnabled)
emailAlertEnabled
- true to enable the email alert feature, false to disable.java.lang.String getEmailName()
void setEmailName(java.lang.String emailName)
emailName
- the name that moderation email alerts will appear to be fromjava.lang.String getEmailAddress()
void setEmailAddress(java.lang.String emailAddress)
emailAddress
- the email address that moderation email alerts will appear to be fromjava.lang.String getEmailSubject(java.util.Locale locale)
locale
-
void setEmailSubject(java.lang.String emailSubject, java.util.Locale locale)
emailSubject
- the text for the subject of moderation email alertslocale
- java.lang.String getEmailBodyText(java.util.Locale locale)
locale
- void setEmailBodyText(java.lang.String emailBodyText, java.util.Locale locale)
emailBodyText
- the plain text body of the moderation email alerts.locale
- java.lang.String getEmailBodyHtml(java.util.Locale locale)
locale
- void setEmailBodyHtml(java.lang.String emailBodyHtml, java.util.Locale locale)
emailBodyHtml
- the html body of the moderation email alerts.locale
-
|
Jive Forums Project Page | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |