Clearspace API (1.7.0) Core Javadocs

Uses of Interface
com.jivesoftware.community.ForumMessage

Packages that use ForumMessage
com.jivesoftware.community Core interfaces and classes for Clearspace. 
com.jivesoftware.community.event Provides mechanisms to be notified of actions in the system such as new messages being created. 
 

Uses of ForumMessage in com.jivesoftware.community
 

Methods in com.jivesoftware.community that return ForumMessage
 ForumMessage Community.createMessage()
          Factory method to create a message with an anonymous author.
 ForumMessage Community.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 Question.getCorrectAnswer()
          Returns the correct answer, or null if no correct answer has been set.
 ForumMessage Community.getLatestMessage()
          Returns the most recently created or edited message in this community (including all sub-communities).
 ForumMessage ForumThread.getLatestMessage()
          Returns the most recently created messages in this thread.
 ForumMessage AbuseReport.getMessage()
          Gets the forum message that caused this abuse report.
 ForumMessage ForumManager.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.community that return types with arguments of type ForumMessage
 JiveIterator<ForumMessage> TreeWalker.getChildren(ForumMessage parent)
          Returns an Iterable for all the child messages of the parent.
 java.util.Collection<ForumMessage> Question.getHelpfulAnswers()
          Returns a read-only Collection of ForumMessage objects that have been marked as helpful.
 JiveIterator<ForumMessage> ContentRetrieval.getMessages()
          Returns an Iterable for all the messages in the community.
 JiveIterator<ForumMessage> ForumThread.getMessages()
          Return an Iterable for all the messages in this thread.
 java.util.List<ForumMessage> ModerationManager.getMessages(AuthToken authToken)
          This method will return a list of messages where the user is a moderator.
 java.lang.Iterable<ForumMessage> ModerationManager.getMessages(AuthToken authToken, Community community)
          Gets a list of moderated messages for a particular community.
 java.util.List<ForumMessage> ModerationManager.getMessages(ModerationFilter modFilter, AuthToken authToken)
          This method will return a list of messages where the user is a moderator.
 java.lang.Iterable<ForumMessage> ModerationManager.getMessages(ModerationFilter modFilter, AuthToken authToken, Community community)
          Gets a list of moderated messages for a particular community.
 JiveIterator<ForumMessage> ContentRetrieval.getMessages(ThreadResultFilter filter)
          Returns an Iterable for all the messages in the community that match the criteria specified by the ResultFilter.
 JiveIterator<ForumMessage> ForumThread.getMessages(ThreadResultFilter resultFilter)
          Returns a Iterable for all the messages in the thread that match the criteria specified by the ResultFilter.
 JiveIterator<ForumMessage> TreeWalker.getRecursiveChildren(ForumMessage parent)
          Returns an Iterable for all child messages (and sub-children, etc) of the parent.
 JiveIterator<ForumMessage> TreeWalker.getRecursiveMessages()
          Returns an Iterable for all messages in the thread in depth-first order.
 JiveIterator<ForumMessage> ReadTracker.getUnreadMessages(User user, Community community)
          Returns an iterable for the unread messages in the community.
 JiveIterator<ForumMessage> ForumManager.getUserMessages(User user)
          Returns an iterable for all messages posted by a user.
 JiveIterator<ForumMessage> ForumManager.getUserMessages(User user, ThreadResultFilter resultFilter)
          Returns an iterable for all messages posted by a user that obey the parameters set by the specified ResultFilter.
 

Methods in com.jivesoftware.community with parameters of type ForumMessage
 void Question.addHelpfulAnswer(ForumMessage message)
          Marks the specified message as a helpful answer to this question.
 void ForumThread.addMessage(ForumMessage parentMessage, ForumMessage newMessage)
          Adds a new message to this thread.
 void SearchManager.addToIndex(ForumMessage message)
          Adds an individual message to the index.
 void ModerationManager.approve(AuthToken authToken, ForumMessage message)
          Approve a moderated message
 SearchQueryCriteria SearchQueryManager.createSearchQueryCriteria(ForumMessage message)
          Returns a SearchQueryCriteria that can be used to query for blog posts, documents and messages that are deemed similar to the provided message.
 ForumThread Community.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.
 void ModerationManager.editAndApprove(AuthToken authToken, ForumMessage message, java.lang.String subject, java.lang.String body, java.lang.String tags)
          Edit and approve a moderated message
 java.util.List<AbuseReport> AbuseManager.getAbuseReports(ForumMessage message)
          Gets a list of open abuse reports for a particular message
 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.
 JiveIterator<ForumMessage> TreeWalker.getChildren(ForumMessage parent)
          Returns an Iterable for all the child messages of the parent.
 int TreeWalker.getIndexOfChild(ForumMessage parent, ForumMessage child)
          Returns the index of child in parent.
 int TreeWalker.getMessageDepth(ForumMessage message)
          Returns the depth of a message in the message tree hierarchy.
 int AbuseManager.getNumberOfAbuseReports(ForumMessage message)
          Gets the number of abuse reports for a particular message
 ForumMessage TreeWalker.getParent(ForumMessage child)
          Returns the parent of the child ForumMessage.
 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.
 JiveIterator<ForumMessage> TreeWalker.getRecursiveChildren(ForumMessage parent)
          Returns an Iterable 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 AbuseManager.hasUserReportedAbuse(ForumMessage message, User user)
          Checks if a user has already reported abuse for a particular message.
 boolean Question.isCorrectAnswer(ForumMessage message)
          Returns true if the specified message is the correct answer.
 boolean Question.isHelpfulAnswer(ForumMessage message)
          Returns true if the specified message has been marked as a helpful answer to this question.
 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 ModerationManager.reject(AuthToken authToken, ForumMessage message)
          Reject a moderated message
 void SearchManager.removeFromIndex(ForumMessage message)
          Removes an individual message from the index.
 void AbuseManager.resolveAbuseReports(ForumMessage message)
          REsolves all abuse reports for a particular message
 void Question.setCorrectAnswer(ForumMessage message)
          Sets the specified message as the correct answer.
 void AbuseReport.setMessage(ForumMessage message)
          Sets the forum message that caused this abuse report.
 void SearchManager.updateIndex(ForumMessage message)
          Update an individual message in the index.
 

Uses of ForumMessage in com.jivesoftware.community.event
 

Methods in com.jivesoftware.community.event that return ForumMessage
 ForumMessage MessageEvent.getMessage()
          Returns the ForumMessage that the event corresponds to.
 

Constructors in com.jivesoftware.community.event with parameters of type ForumMessage
MessageEvent(int eventType, ForumMessage message, java.util.Map<java.lang.String,? extends java.lang.Object> params)
          Creates a new message event.
 


Clearspace Project Page

Copyright © 1999-2007 Jive Software.