|
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.interceptor.UserInterceptor
public class UserInterceptor
An interceptor to ban users by preventing them from posting messages.
Field Summary |
---|
Fields inherited from interface com.jivesoftware.forum.MessageInterceptor |
---|
TYPE_ALL, TYPE_BOTH, TYPE_EDIT, TYPE_POST, TYPE_PRE |
Constructor Summary | |
---|---|
UserInterceptor()
|
|
UserInterceptor(int objectType,
long objectID)
|
Method Summary | |
---|---|
java.lang.String |
getBanList()
Returns the list of banned users as a list of comma-delimited usernames or the empty string if no banned users exist. |
java.lang.String |
getEmailBodyTemplate()
Deprecated. replaced by getEmailBodyTemplate(java.util.Locale) |
java.lang.String |
getEmailBodyTemplate(java.util.Locale locale)
|
java.lang.String |
getEmailSubject()
Deprecated. replaced by getEmailSubject(java.util.Locale) |
java.lang.String |
getEmailSubject(java.util.Locale locale)
|
java.lang.String |
getFromEmail()
|
java.lang.String |
getFromName()
|
int |
getType()
Returns the type of the interceptor. |
void |
invokeInterceptor(ForumMessage message,
int type)
Checks to see if the author of the message is a banned user. |
boolean |
isNotificationEnabled()
|
void |
setBanList(java.lang.String usernames)
Sets the list of banned usernames. |
void |
setEmailBodyTemplate(java.lang.String emailBodyTemplate)
Deprecated. replaced by setEmailBodyTemplate(String, java.util.Locale) |
void |
setEmailBodyTemplate(java.lang.String emailBodyTemplate,
java.util.Locale locale)
|
void |
setEmailSubject(java.lang.String emailSubject)
Deprecated. replaced by setEmailSubject(String, java.util.Locale) |
void |
setEmailSubject(java.lang.String emailSubject,
java.util.Locale locale)
|
void |
setFromEmail(java.lang.String fromEmail)
|
void |
setFromName(java.lang.String fromName)
|
void |
setNotificationEnabled(boolean notificationEnabled)
|
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public UserInterceptor()
public UserInterceptor(int objectType, long objectID)
Method Detail |
---|
public java.lang.String getEmailBodyTemplate()
getEmailBodyTemplate(java.util.Locale)
public java.lang.String getEmailBodyTemplate(java.util.Locale locale)
public void setEmailBodyTemplate(java.lang.String emailBodyTemplate)
setEmailBodyTemplate(String, java.util.Locale)
public void setEmailBodyTemplate(java.lang.String emailBodyTemplate, java.util.Locale locale)
public java.lang.String getEmailSubject()
getEmailSubject(java.util.Locale)
public java.lang.String getEmailSubject(java.util.Locale locale)
public void setEmailSubject(java.lang.String emailSubject)
setEmailSubject(String, java.util.Locale)
public void setEmailSubject(java.lang.String emailSubject, java.util.Locale locale)
public java.lang.String getFromEmail()
public void setFromEmail(java.lang.String fromEmail)
public java.lang.String getFromName()
public void setFromName(java.lang.String fromName)
public boolean isNotificationEnabled()
public void setNotificationEnabled(boolean notificationEnabled)
public java.lang.String getBanList()
public void setBanList(java.lang.String usernames)
usernames
- the list of banned usernames.public int getType()
MessageInterceptor
getType
in interface MessageInterceptor
public void invokeInterceptor(ForumMessage message, int type) throws MessageRejectedException
invokeInterceptor
in interface MessageInterceptor
message
- the message to check.
MessageRejectedException
- if the user posting the message is on the banned list.
|
Jive Forums Project Page | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |