|
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.GatewayInterceptor
public class GatewayInterceptor
An interceptor that allows for the hiding of name and email information for messages imported via a gateway.
Field Summary |
---|
Fields inherited from interface com.jivesoftware.forum.MessageInterceptor |
---|
TYPE_ALL, TYPE_BOTH, TYPE_EDIT, TYPE_POST, TYPE_PRE |
Constructor Summary | |
---|---|
GatewayInterceptor()
|
|
GatewayInterceptor(int type,
long objectID)
|
Method Summary | |
---|---|
java.lang.String |
getEmailProp()
Returns the name of the Jive property to save emails into if isStoreEmailAsProp() is
true. |
java.lang.String |
getNameProp()
Returns the name of the Jive property to save names into if isStoreNameAsProp() is
true. |
int |
getType()
Returns the type of the interceptor. |
void |
invokeInterceptor(ForumMessage message,
int type)
Invokes the interceptor on the specified message. |
boolean |
isHideEmail()
Returns true if the poster's email should be hidden when a gateway message is imported, false otherwise. |
boolean |
isHideName()
Returns true if the poster's name should be hidden when a gateway message is imported, false otherwise. |
boolean |
isStoreEmailAsProp()
Returns whether to store the poster's email in a seperate extended property when hiding emails. |
boolean |
isStoreNameAsProp()
Returns whether to store the poster's name in a seperate extended property when hiding names. |
void |
setEmailProp(java.lang.String emailProp)
Sets the name of the Jive property to save emails into if isStoreEmailAsProp() is
true. |
void |
setHideEmail(boolean hideEmail)
Sets whether the poster's email should be hidden when a gateway message is imported. |
void |
setHideName(boolean hideName)
Sets whether the poster's name should be hidden when a gateway message is imported. |
void |
setNameProp(java.lang.String nameProp)
Sets the name of the Jive property to save names into if isStoreNameAsProp() is
true. |
void |
setStoreEmailAsProp(boolean storeEmailAsProp)
Sets whether to store the poster's email in a seperate extended property. |
void |
setStoreNameAsProp(boolean storeNameAsProp)
Sets whether to store the poster's name in a seperate extended property. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public GatewayInterceptor()
public GatewayInterceptor(int type, long objectID)
Method Detail |
---|
public boolean isHideName()
public void setHideName(boolean hideName)
hideName
- true to hide names, false otherwise.public boolean isHideEmail()
public void setHideEmail(boolean hideEmail)
hideEmail
- true to hide emails, false otherwise.public boolean isStoreNameAsProp()
public void setStoreNameAsProp(boolean storeNameAsProp)
storeNameAsProp
- true to store the poster's name in a seperate extended property when
hiding names, false otherwise.public boolean isStoreEmailAsProp()
public void setStoreEmailAsProp(boolean storeEmailAsProp)
storeEmailAsProp
- true to store the poster's email in a seperate extended property when
hiding emails, false otherwise.public java.lang.String getNameProp()
isStoreNameAsProp()
is
true.
public void setNameProp(java.lang.String nameProp)
isStoreNameAsProp()
is
true.
nameProp
- the name of the Jive property to save names intopublic java.lang.String getEmailProp()
isStoreEmailAsProp()
is
true.
public void setEmailProp(java.lang.String emailProp)
isStoreEmailAsProp()
is
true.
emailProp
- the name of the Jive property to save emails intopublic int getType()
MessageInterceptor
getType
in interface MessageInterceptor
public void invokeInterceptor(ForumMessage message, int type) throws MessageRejectedException
MessageInterceptor
invokeInterceptor
in interface MessageInterceptor
message
- the message to take action on.
MessageRejectedException
- if the message should be prevented from being posted.
|
Jive Forums Project Page | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |