|
Jive Forums API (5.5.20.2-oracle) Core Javadocs | |||||||||
PREV NEXT | FRAMES NO FRAMES |
Packages that use ForumCategory | |
---|---|
com.jivesoftware.forum | Core interfaces and classes for Jive Forums. |
com.jivesoftware.forum.event | Provides mechanisms to be notified of actions in the system such as new messages being created. |
Uses of ForumCategory in com.jivesoftware.forum |
---|
Methods in com.jivesoftware.forum that return ForumCategory | |
---|---|
ForumCategory |
ForumCategory.createCategory(java.lang.String name,
java.lang.String description)
Creates a new ForumCategory as a sub-category of this category using the name and description. |
ForumCategory |
Forum.getForumCategory()
Returns the forum category that this forum belongs to. |
abstract ForumCategory |
ForumFactory.getForumCategory(long categoryID)
Returns the forum category with the specified categoryID. |
ForumCategory |
ForumCategory.getParentCategory()
Returns the parent category of this category. |
abstract ForumCategory |
ForumFactory.getRootForumCategory()
Returns the "root" forum category, that all other categories are children of. |
Methods in com.jivesoftware.forum with parameters of type ForumCategory | |
---|---|
Announcement |
AnnouncementManager.createAnnouncement(User user,
ForumCategory category)
Creates a new category announcement. |
abstract Forum |
ForumFactory.createForum(java.lang.String name,
java.lang.String description,
ForumCategory category)
Creates a new forum in the specified category. |
Watch |
WatchManager.createWatch(User user,
ForumCategory category)
Create a watch on a category for the specified user. |
void |
ForumCategory.deleteCategory(ForumCategory subCategory)
Deletes a sub-category. |
long[] |
StatusLevelCalculator.getLeaderIds(ForumCategory category,
int startIndex,
int numResults)
Returns a long array of user ids of forum category leaders given a start index and desired number of results. |
java.util.Iterator |
StatusLevelManager.getLeaders(ForumCategory category)
Returns an Iterator of leaders for a specific forum category |
java.util.Iterator |
StatusLevelManager.getLeaders(ForumCategory category,
int startIndex,
int numResults)
Returns an Iterator of leaders for a specific forum category |
int |
StatusLevelCalculator.getPointLevel(User user,
ForumCategory category)
Returns the status level points for a user in regards to a specific category |
int |
StatusLevelManager.getPointLevel(User user,
ForumCategory category)
Returns the status level points for a user in regards to a specific category |
int |
RewardManager.getPointsEarned(User user,
ForumCategory category)
Returns the total number of points the user has earned in a particular category. |
java.util.Iterator |
TagManager.getPopularTags(ForumCategory forumCategory)
Get popular tags |
int |
AnnouncementManager.getRecursiveAnnouncementCount(ForumCategory category)
Returns the count of all currently viewable announcements in a ForumCategory and its child Forums and SubCategories. |
java.util.Iterator |
AnnouncementManager.getRecursiveAnnouncements(ForumCategory category,
int startIndex,
int numResults)
Returns all currently viewable announcements in a ForumCategory and its child Forums and SubCategories. |
int |
WatchManager.getRecursiveForumWatchCount(User user,
ForumCategory category)
Returns number of Forum objects the user is watching under the category and its subcategories. |
java.util.Iterator |
WatchManager.getRecursiveForumWatches(User user,
ForumCategory category,
int startIndex,
int numResults)
Returns all the Forum objects the user is watching under the category and its subcategories. |
int |
WatchManager.getRecursiveThreadWatchCount(User user,
ForumCategory category)
Returns the number of ForumThread objects the user is watching under the provided ForumCategory. |
java.util.Iterator |
WatchManager.getRecursiveThreadWatches(User user,
ForumCategory category,
int startIndex,
int numResults)
Returns the ForumThread objects the user is watching under the provided ForumCategory. |
StatusLevel |
StatusLevelManager.getStatusLevel(User user,
ForumCategory category)
Returns the status level for a user in a specific category. if a status level cannot be determined for this user in this category null will be returned. |
java.util.Iterator |
WatchManager.getThreadWatches(User user,
ForumCategory category,
int startIndex,
int numResults)
Returns the ForumThread objects the user is watching under the provided ForumCategory. |
java.util.Iterator |
RewardManager.getTopUsers(int startIndex,
int numResults,
ForumCategory category)
Returns an iterator for the top point earners in a category. |
int |
ReadTracker.getUnreadMessageCount(User user,
ForumCategory category)
Returns the count of unread messages that the user has in the category. |
java.util.Iterator |
ReadTracker.getUnreadMessages(User user,
ForumCategory category)
Returns an iterator for the unread messages in the category. |
int |
ReadTracker.getUnreadThreadCount(User user,
ForumCategory category)
Returns the count of unread threads that the user has in the category. |
java.util.Iterator |
ReadTracker.getUnreadThreads(User user,
ForumCategory category)
Returns an iterator for the unread threads in the category. |
Watch |
WatchManager.getWatch(User user,
ForumCategory category)
Returns a watch on a particular category, or null if there isn't a watch. |
int |
WatchManager.getWatchCount(User user,
ForumCategory category)
Return the count of all forum watches in a particular category for the given user. |
java.util.Iterator |
WatchManager.getWatches(User user,
ForumCategory category)
Returns an Iterator for all the forum objects a user is watching in a category. |
java.util.Iterator |
WatchManager.getWatches(User user,
ForumCategory category,
int startIndex,
int numResults)
Returns the Forums watched by the User under the given Category. |
boolean |
WatchManager.isWatched(User user,
ForumCategory category)
Returns true if the user is watching the specified category. |
void |
ReadTracker.markRead(User user,
ForumCategory category)
Marks an entire category as read up until the current instant in time. |
void |
ForumCategory.moveCategory(ForumCategory subCategory,
ForumCategory destinationCategory)
Moves a sub-category to another category. |
void |
ForumCategory.moveForum(Forum forum,
ForumCategory destinationCategory)
Moves a forum from this category to another. |
void |
ForumCategory.setCategoryIndex(ForumCategory subCategory,
int newIndex)
Sets the display order of a sub-category. |
Uses of ForumCategory in com.jivesoftware.forum.event |
---|
Methods in com.jivesoftware.forum.event that return ForumCategory | |
---|---|
ForumCategory |
CategoryEvent.getCategory()
Returns the ForumCategory that the event corresponds to. |
Constructors in com.jivesoftware.forum.event with parameters of type ForumCategory | |
---|---|
CategoryEvent(int eventType,
ForumCategory category,
java.util.Map params)
Creates a new forum event. |
|
Jive Forums Project Page | |||||||||
PREV NEXT | FRAMES NO FRAMES |