|
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.RSSPopularThreads
public class RSSPopularThreads
A simple action to return the list of popular threads in a category, forum or the whole 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 | |
---|---|
RSSPopularThreads()
|
Method Summary | |
---|---|
java.lang.String |
executeRSS()
Main action execution method - returns Action.SUCCESS by default. |
long |
getCategoryID()
|
java.lang.String |
getFeedTitle()
Returns the title of the RSS feed unique to the category or forum. |
long |
getForumID()
|
boolean |
getFull()
Indicates if the full message body content should be returned or just a summary. |
java.util.Iterator |
getThreads()
Returns the list of popular threads or an empty list if none exists. |
boolean |
isFull()
Indicates if the full message body content should be returned or just a summary. |
void |
setCategoryID(long categoryID)
|
void |
setForumID(long forumID)
|
void |
setFull(boolean full)
Sets whether or not to return the full message body content or just a summary. |
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 RSSPopularThreads()
Method Detail |
---|
public long getCategoryID()
public void setCategoryID(long categoryID)
public long getForumID()
public void setForumID(long forumID)
public boolean isFull()
public boolean getFull()
public void setFull(boolean full)
public java.util.Iterator getThreads()
public java.lang.String getFeedTitle()
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 |