|
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.opensymphony.xwork.ActionSupport
com.jivesoftware.base.action.rss.RSSActionSupport
com.jivesoftware.forum.action.rss.RSSPopularForums
public class RSSPopularForums
A simple action to return the list of popular forums in the system. Note, this feed is best designed to syndicate content to other parts of your site and not necessarily serve information to users directly.
Field Summary |
---|
Fields inherited from class com.jivesoftware.base.action.rss.RSSActionSupport |
---|
DATE_FORMAT, DEFAULT_NUM_ITEMS, DISABLED, request, response |
Fields inherited from class com.opensymphony.xwork.ActionSupport |
---|
LOG |
Fields inherited from interface com.opensymphony.xwork.Action |
---|
ERROR, INPUT, LOGIN, NONE, SUCCESS |
Constructor Summary | |
---|---|
RSSPopularForums()
|
Method Summary | |
---|---|
java.lang.String |
executeRSS()
Main action execution method - returns Action.SUCCESS by default. |
java.lang.String |
getFeedTitle()
Returns a suggested title for the RSS feed -- subclasses should override this method and provide a title that is unique. |
java.util.Iterator |
getForums()
Return an iterator of the most popular forums in the system or an empty iterator if no popular forums exist. |
Methods inherited from class com.jivesoftware.base.action.rss.RSSActionSupport |
---|
execute, getAuthToken, getDateFormat, getDefaultBaseURL, getNumItems, getPageUser, getPassword, getUsername, rssFeedsEnabled, setAuthToken, setNumItems, setPassword, setServletRequest, setServletResponse, setUsername |
Methods inherited from class com.opensymphony.xwork.ActionSupport |
---|
addActionError, addActionMessage, addFieldError, clearErrorsAndMessages, clone, doDefault, doInput, getActionErrors, getActionMessages, getErrorMessages, getErrors, getFieldErrors, getLocale, getText, getText, getText, getText, getText, getText, getText, getText, getText, getTexts, getTexts, hasActionErrors, hasActionMessages, hasErrors, hasFieldErrors, hasKey, pause, setActionErrors, setActionMessages, setFieldErrors, validate |
Methods inherited from class java.lang.Object |
---|
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public RSSPopularForums()
Method Detail |
---|
public java.util.Iterator getForums()
public java.lang.String getFeedTitle()
RSSActionSupport
getFeedTitle
in class RSSActionSupport
public java.lang.String executeRSS()
RSSActionSupport
Action.SUCCESS
by default. Subclassers should
override this method for additional functionality.
executeRSS
in class RSSActionSupport
|
Jive Forums Project Page | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |