|
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.expert.OpenQuestionAlertSettings
public class OpenQuestionAlertSettings
Holds the settings used by OpenQuestionMonitor
in determining when and how to send email alerts.
Instances of this class are associated with either a Forum
or ForumCategory
, and should be
obtained by calling OpenQuestionMonitor#getAlertSettings
and passing the Forum
or ForumCategory
you wish to associate an alert with.
OpenQuestionMonitor
Method Summary | |
---|---|
static java.lang.String |
emailListToString(java.util.List addresses)
Returns a comma-delimited string of email addresses. |
static java.util.List |
emailStringToList(java.lang.String notifyList)
Returns a List of email addresses contained in the supplied string. |
boolean |
equals(java.lang.Object other)
|
ForumCategory |
getCategory()
Returns the ForumCategory for which this instance holds open email alert settings. |
java.lang.String |
getEmailAddress()
Returns the email address that notification emails will appear to be from. |
java.lang.String |
getEmailName()
Returns the name that notification emails will appear to be from. |
java.util.List |
getEmailNotifyList()
Returns the List containine all the email addresses that
will be notified of an open question. |
java.lang.String |
getEmailNotifyListAsString()
Returns the list of email addresses that will be notified of an open question. |
java.lang.String |
getEmailSubject(java.util.Locale locale)
Returns the subject of the notification emails. |
Forum |
getForum()
Returns the Forum for which this instance holds open email alert settings. |
java.lang.Object |
getForumOrCategory()
Returns either the Forum or ForumCategory (whichever is non null) for
which this instance holds open email alert settings. |
java.lang.String |
getHTMLEmailBody(java.util.Locale locale)
Returns the HTML body of the nofication emails. |
int |
getMaxOpenHours()
Returns the maximum number of hours a question can be Question.State.open open before triggering an alert. |
java.lang.String |
getTextEmailBody(java.util.Locale locale)
Returns the plain-text body of the nofication emails. |
int |
hashCode()
|
boolean |
isEnabled()
Returns true if the open question monitoring feature is enabled for the Category or Forum this instance is associated with. |
void |
setEmailAddress(java.lang.String emailAddress)
Sets the email address that notification emails will appear to be from. |
void |
setEmailName(java.lang.String emailName)
Sets the name that notification emails will appear to be from. |
void |
setEmailNotifyList(java.lang.String notifyList)
Sets the list of email addresses that will be notified when keywords are found. |
void |
setEmailSubject(java.lang.String emailSubject,
java.util.Locale locale)
Sets the subject of the nofitication emails. |
void |
setEnabled(boolean enabled)
Enables or disables the open question monitoring feature for the Category or Forum this instance is associated with. |
void |
setHTMLEmailBody(java.lang.String htmlEmailBody,
java.util.Locale locale)
Sets the HTML body of the nofication emails. |
void |
setMaxOpenHours(int maxOpenHours)
Sets the maximum number of hours a question can be Question.State.open open before triggering an alert. |
void |
setTextEmailBody(java.lang.String textEmailBody,
java.util.Locale locale)
Sets the plain-text body of the nofication emails. |
Methods inherited from class java.lang.Object |
---|
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait |
Method Detail |
---|
public boolean isEnabled()
public void setEnabled(boolean enabled)
enabled
- true to enable.public int getMaxOpenHours()
Question.State.open
open before triggering an alert.
public void setMaxOpenHours(int maxOpenHours)
Question.State.open
open before triggering an alert.
maxOpenHours
- max open hours.public java.lang.String getEmailNotifyListAsString()
public java.util.List getEmailNotifyList()
List
containine all the email addresses that
will be notified of an open question.
List
containine all the email addresses that
will be notified of an open question.public void setEmailNotifyList(java.lang.String notifyList)
notifyList
- the comma-delimited list of notification email addresses.public java.lang.String getEmailName()
public void setEmailName(java.lang.String emailName)
emailName
- the name that notification emails will appear from.public java.lang.String getEmailAddress()
public void setEmailAddress(java.lang.String emailAddress)
emailAddress
- the email address that notification emails will appear from.public java.lang.String getEmailSubject(java.util.Locale locale)
locale
-
public void setEmailSubject(java.lang.String emailSubject, java.util.Locale locale)
emailSubject
- the subject of notification emails.locale
- public java.lang.String getTextEmailBody(java.util.Locale locale)
locale
-
public void setTextEmailBody(java.lang.String textEmailBody, java.util.Locale locale)
textEmailBody
- the plain-text body of the notification emails.locale
- public java.lang.String getHTMLEmailBody(java.util.Locale locale)
locale
-
public void setHTMLEmailBody(java.lang.String htmlEmailBody, java.util.Locale locale)
htmlEmailBody
- the HTML body of the notification emails.locale
- public Forum getForum()
Forum
for which this instance holds open email alert settings.
Forum
for which this instance holds open email alert settings.public ForumCategory getCategory()
ForumCategory
for which this instance holds open email alert settings.
ForumCategory
for which this instance holds open email alert settings.public java.lang.Object getForumOrCategory()
Forum
or ForumCategory
(whichever is non null) for
which this instance holds open email alert settings.
Forum
or ForumCategory
for which this instance holds open email alert settings.public boolean equals(java.lang.Object other)
equals
in class java.lang.Object
public int hashCode()
hashCode
in class java.lang.Object
public static java.lang.String emailListToString(java.util.List addresses)
addresses
- the List
containing email addresses.
public static java.util.List emailStringToList(java.lang.String notifyList)
List
of email addresses contained in the supplied string.
notifyList
- the comma-delimited list of notification email addresses.
List
of email addresses.
|
Jive Forums Project Page | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |