|
Jive Forums API (5.5.20.2-oracle) Core Javadocs | |||||||||
PREV NEXT | FRAMES NO FRAMES |
Packages that use ForumMessage | |
---|---|
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 ForumMessage in com.jivesoftware.forum |
---|
Methods in com.jivesoftware.forum that return ForumMessage | |
---|---|
ForumMessage |
Forum.createMessage()
Factory method to create a message with an anonymous author. |
ForumMessage |
Forum.createMessage(User user)
Factory method to create a message as the specified user. |
ForumMessage |
TreeWalker.getChild(ForumMessage parent,
int index)
Returns the child of parent at index index in the parent's child array. |
ForumMessage |
MessageRejectedException.getForumMessage()
Returns the message that triggered the exception. |
ForumMessage |
Forum.getLatestMessage()
Returns the most recently created or edited message in this forum. |
ForumMessage |
ForumCategory.getLatestMessage()
Returns the most recently created or edited message in this category (including all sub-categories). |
ForumMessage |
ForumThread.getLatestMessage()
Returns the most recently created messages in this thread. |
ForumMessage |
QueryResult.getMessage()
Get the message this query result pertains to. |
abstract ForumMessage |
ForumFactory.getMessage(long messageID)
Returns the forum message with the specified messageID. |
ForumMessage |
ForumThread.getMessage(long messageID)
Returns a message from this thread based on its id. |
ForumMessage |
TreeWalker.getParent(ForumMessage child)
Returns the parent of the child ForumMessage. |
ForumMessage |
ForumMessage.getParentMessage()
Returns the parent message of this message or null if this message is the root message of a thread. |
ForumMessage |
TreeWalker.getRoot()
Returns the root of the tree. |
ForumMessage |
ForumThread.getRootMessage()
Returns the root message this thread. |
Methods in com.jivesoftware.forum with parameters of type ForumMessage | |
---|---|
void |
ForumThread.addMessage(ForumMessage parentMessage,
ForumMessage newMessage)
Adds a new message to this thread. |
void |
RatingManager.addRating(User user,
ForumMessage message,
Rating rating)
Add a rating to the forum message. |
void |
SearchManager.addToIndex(ForumMessage message)
Adds an individual message to the index. |
ForumThread |
Forum.createThread(ForumMessage rootMessage)
Factory method to create a new thread. |
void |
ForumThread.deleteMessage(ForumMessage message)
Deletes a message in this thread. |
void |
ForumThread.deleteMessage(ForumMessage message,
boolean deleteChildren)
Deletes a message in this thread, optionally recusively deleting child messages. |
ForumMessage |
TreeWalker.getChild(ForumMessage parent,
int index)
Returns the child of parent at index index in the parent's child array. |
int |
TreeWalker.getChildCount(ForumMessage parent)
Returns the number of children of parent. |
java.util.Iterator |
TreeWalker.getChildren(ForumMessage parent)
Returns an Iterator for all the child messages of the parent. |
int |
TreeWalker.getIndexOfChild(ForumMessage parent,
ForumMessage child)
Returns the index of child in parent. |
double |
RatingManager.getMeanRating(ForumMessage message)
A convenience method which returns a geometric mean average of all the ratings given to the forum message. |
int |
TreeWalker.getMessageDepth(ForumMessage message)
Returns the depth of a message in the message tree hierarchy. |
ForumMessage |
TreeWalker.getParent(ForumMessage child)
Returns the parent of the child ForumMessage. |
int |
RewardManager.getPoints(ForumMessage message)
Returns the number of reward points that have been assigned to a message. |
Rating |
RatingManager.getRating(User user,
ForumMessage message)
Returns the rating associated with the user, or null if this user hasn't rated the forum message. |
int |
RatingManager.getRatingCount(ForumMessage message)
Returns the total number of ratings given to the forum message. |
java.util.Iterator |
RatingManager.getRatings(ForumMessage message)
Returns an Iterator of all the ratings given to the forum message. |
int |
ReadTracker.getReadStatus(User user,
ForumMessage message)
Returns the read status on the specified message. |
int |
TreeWalker.getRecursiveChildCount(ForumMessage parent)
Returns the total number of recursive children of a parent. |
java.util.Iterator |
TreeWalker.getRecursiveChildren(ForumMessage parent)
Returns an Iterator for all child messages (and sub-children, etc) of the parent. |
boolean |
TreeWalker.hasParent(ForumMessage child)
Returns true if the child message has a parent message. |
boolean |
RatingManager.hasRated(User user,
ForumMessage message)
Returns whether the user has rated the forum message or not. |
void |
MessageInterceptor.invokeInterceptor(ForumMessage message,
int type)
Invokes the interceptor on the specified message. |
boolean |
TreeWalker.isLeaf(ForumMessage node)
Returns true if node is a leaf. |
void |
ReadTracker.markRead(User user,
ForumMessage message)
Marks an individual message as read. |
void |
SearchManager.removeFromIndex(ForumMessage message)
Removes an individual message from the index. |
void |
RewardManager.rewardPoints(ForumMessage message,
int numPoints)
Rewards a message with points from the thread that the message belongs to. |
void |
QueryResult.setMessage(ForumMessage message)
Set the entry this query result pertains to. |
Constructors in com.jivesoftware.forum with parameters of type ForumMessage | |
---|---|
MessageRejectedException(java.lang.String rejectionMessage,
ForumMessage forumMessage)
|
|
MessageRejectedException(java.lang.Throwable nestedThrowable,
ForumMessage forumMessage)
|
|
QueryResult(ForumMessage message,
float relevance)
Creates a new QueryResult object. |
Uses of ForumMessage in com.jivesoftware.forum.event |
---|
Methods in com.jivesoftware.forum.event that return ForumMessage | |
---|---|
ForumMessage |
MessageEvent.getMessage()
Returns the ForumMessage that the event corresponds to. |
Constructors in com.jivesoftware.forum.event with parameters of type ForumMessage | |
---|---|
MessageEvent(int eventType,
ForumMessage message,
java.util.Map params)
Creates a new message event. |
|
Jive Forums Project Page | |||||||||
PREV NEXT | FRAMES NO FRAMES |