|
Clearspace API (1.7.0) Core Javadocs | |||||||||
| PREV NEXT | FRAMES NO FRAMES | |||||||||
| Packages that use Community | |
|---|---|
| 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. |
| com.jivesoftware.community.widget | |
| Uses of Community in com.jivesoftware.community |
|---|
| Methods in com.jivesoftware.community that return Community | |
|---|---|
Community |
Community.createCommunity(java.lang.String name,
java.lang.String displayName,
java.lang.String description)
Creates a new Community as a sub-community of this community using the name and description. |
Community |
ArchiveManager.getArchiveCommunity(Community community)
Returns the "archive community" for the specified community. |
Community |
Document.getCommunity()
Returns the community of the document. |
Community |
ForumMessage.getCommunity()
Returns the community this message belongs to. |
Community |
ForumThread.getCommunity()
Returns the community this thread belongs to. |
Community |
ProfileSearchQuery.getCommunity()
Gets the community used for this query. |
Community |
TagSet.getCommunity()
Returns the Community to which this TagSet is bound. |
Community |
CommunityManager.getCommunity(long communityID)
Returns the Community with the supplied communityID. |
Community |
CommunityManager.getCommunity(java.lang.String nntpName)
Returns the community with the specified NNTP name. |
Community |
Community.getParentCommunity()
Returns the parent community of this community. |
Community |
CommunityManager.getRootCommunity()
Returns the "root" community that all other communities are children of. |
| Methods in com.jivesoftware.community that return types with arguments of type Community | |
|---|---|
java.util.Map<Community,java.lang.Long> |
StatusLevelManager.getAllPointLevels(User user)
Returns a map of community -> status level points for all the communities the user has points in. |
JiveIterator<Community> |
Blog.getCommunities()
Returns the communities this blog has been associated with. |
JiveIterator<Community> |
Community.getCommunities()
Returns an Iterable for the child communities of this community. |
java.util.List<Community> |
ModerationManager.getCommunities(AuthToken authToken)
This method will return a list of communities where the user is a moderator. |
JiveIterator<Community> |
Community.getCommunities(int startIndex,
int numResults)
Returns an Iterable for the child communities of this community using a start index and the number of results to return. |
JiveIterator<Community> |
Community.getRecursiveCommunities()
Returns an Iterable for all sub-communities of this community, including sub-communities of sub-communities, etc. |
JiveIterator<Community> |
SearchQuery.getResultCommunities()
Returns an Iterable of the Communities that search results are from. |
| Methods in com.jivesoftware.community with parameters of type Community | |
|---|---|
void |
StatusLevelManager.addPoints(User user,
Community community,
JiveObject object,
long points,
java.lang.String code)
Rewards points to a user. |
void |
SearchManager.addToIndex(Community community)
Adds an individual community to the index. |
Announcement |
AnnouncementManager.createAnnouncement(User user,
Community community)
Creates a new community announcement. |
static CommentResultFilter |
CommentResultFilter.createDefaultFilter(Community community)
Creates a default comment ResultFilter: no filtering with results sorted on the comment creation date. |
SearchQuery |
SearchQueryManager.createSearchQuery(SearchQueryCriteria criteria,
Community... communities)
Creates a SearchQuery object to search through the specified array of communities. |
TagSet |
TagSetManager.createTagSet(java.lang.String name,
java.lang.String description,
java.lang.Iterable<ContentTag> tags,
Community community)
Creates a new TagSet with the supplied name, description, and tags. |
void |
CommunityManager.deleteCommunity(Community community)
Deletes a community. |
Community |
ArchiveManager.getArchiveCommunity(Community community)
Returns the "archive community" for the specified community. |
int |
ArchiveManager.getArchiveDays(Community community)
Returns the number of days that threads in community must be inactive before being archived. |
int |
ArchiveManager.getArchiveMode(Community community)
Returns the archive mode for the community. |
Document |
DocumentManager.getDocument(Community community,
java.lang.String subject)
Returns a document from a community based on its subject. |
long[] |
StatusLevelCalculator.getLeaderIds(Community community,
int startIndex,
int numResults)
Returns a long array of user ids of community leaders given a start index and desired number of results. |
java.lang.Iterable<User> |
StatusLevelManager.getLeaders(Community community)
Returns an Iterable of leaders for a specific community |
java.lang.Iterable<User> |
StatusLevelManager.getLeaders(Community community,
int startIndex,
int numResults)
Returns an Iterable of leaders for a specific community |
java.util.Locale |
LocaleManager.getLocale(Community community,
User user,
javax.servlet.http.HttpServletRequest req)
Returns a Locale object for the specified entity, if one exists. |
int |
ModerationManager.getMessageCount(Community community)
Gets the number of moderated messages in a community |
int |
ModerationManager.getMessageCount(ModerationFilter modFilter,
Community community)
Gets the number of moderated messages in a community |
java.lang.Iterable<ForumMessage> |
ModerationManager.getMessages(AuthToken authToken,
Community community)
Gets a list of moderated messages for a particular community. |
java.lang.Iterable<ForumMessage> |
ModerationManager.getMessages(ModerationFilter modFilter,
AuthToken authToken,
Community community)
Gets a list of moderated messages for a particular community. |
long |
StatusLevelCalculator.getPointLevel(User user,
Community community)
Returns the status level points for a user in regards to a specific community |
long |
StatusLevelManager.getPointLevel(User user,
Community community)
Returns the status level points for a user in regards to a specific community |
int |
QuestionManager.getQuestionCount(Community community)
Returns the count of all questions in a community. |
int |
QuestionManager.getQuestionCount(Community community,
QuestionFilter questionFilter)
Returns the count of questions in a community that pass the specified question filter. |
JiveIterator<Question> |
QuestionManager.getQuestions(Community community)
Returns an iterable for all questions in a community. |
JiveIterator<Question> |
QuestionManager.getQuestions(Community community,
QuestionFilter questionFilter)
Returns an iterable for all questions in a categetory that pass the specified question filter. |
int |
SearchQuery.getResultCommunityCount(Community community)
Returns the number of document results in the search that match the given community. |
StatusLevel |
StatusLevelManager.getStatusLevel(User user,
Community community)
Returns the status level for a user in a specific community. if a status level cannot be determined for this user in this community null will be returned. |
JiveIterator<TagSet> |
TagSetManager.getTagSets(Community community)
Returns all TagSets which are defined for the specified Community. |
int |
ReadTracker.getUnreadMessageCount(User user,
Community community)
Returns the count of unread messages that the user has in the community. |
JiveIterator<ForumMessage> |
ReadTracker.getUnreadMessages(User user,
Community community)
Returns an iterable for the unread messages in the community. |
int |
ReadTracker.getUnreadThreadCount(User user,
Community community)
Returns the count of unread threads that the user has in the community. |
JiveIterator<ForumThread> |
ReadTracker.getUnreadThreads(User user,
Community community)
Returns an iterable for the unread threads in the community. |
int |
WatchManager.getWatchCount(User user,
Community community)
Return the count of all forum watches in a particular community for the given user. |
JiveIterator<JiveObject> |
WatchManager.getWatches(User user,
Community community)
Returns an Iterable for all the Community objects a user is watching in a community. |
boolean |
ArchiveManager.isArchivingEnabled(Community community)
Returns true if archiving is enabled for the specified community. |
void |
ReadTracker.markRead(User user,
Community community)
Marks an entire community as read up until the current instant in time. |
void |
CommunityManager.mergeCommunities(Community destCommunity,
Community srcCommunity)
Merges the content of two communities by copying the threads, documents and blogs from community2 to community1. |
void |
CommunityManager.moveCommunity(Community srcCommunity,
Community destinationCommunity)
Moves a community to another community. |
void |
DocumentManager.moveDocument(Document document,
Community destinationCommunity)
Moves a document from it's current community to another. |
void |
ForumManager.moveThread(ForumThread thread,
Community newCommunity)
Moves a thread from one community to another. |
void |
SearchManager.removeFromIndex(Community community)
Removes a community from the index. |
void |
ArchiveManager.setArchiveCommunity(Community community,
Community archiveCommunity)
Sets the "archive community" for the specified community. |
void |
ArchiveManager.setArchiveDays(Community archive,
int days)
Sets the number of days that threads in community must be inactive before being archived. |
void |
ArchiveManager.setArchiveMode(Community community,
int mode)
Returns the archive mode for the community. |
void |
ArchiveManager.setArchivingEnabled(Community community,
boolean enabled)
Enables or disables archiving for the specified community. |
void |
ProfileSearchQuery.setCommunity(Community community)
Sets the community the user wants to find an expert in. |
void |
Community.setCommunityIndex(Community subCommunity,
int newIndex)
Sets the display order of a sub-community. |
void |
SearchManager.updateIndex(Community community)
Update an individual community in the index. |
| Constructors in com.jivesoftware.community with parameters of type Community | |
|---|---|
ProfileSearchQuery(java.lang.String keywords,
java.util.List<ProfileSearchFilter> filters,
org.apache.lucene.search.Sort sort,
boolean searchUsername,
boolean searchName,
boolean searchEmail,
boolean searchProfile,
boolean admin,
Community community)
Creates a new query, results sorted by the given sort. |
|
| Uses of Community in com.jivesoftware.community.event |
|---|
| Methods in com.jivesoftware.community.event that return Community | |
|---|---|
Community |
CommunityEvent.getCommunity()
|
Community |
DocumentEvent.getCommunity()
|
| Constructors in com.jivesoftware.community.event with parameters of type Community | |
|---|---|
CommunityEvent(int eventType,
Community community,
java.util.Map<java.lang.String,?> params)
|
|
DocumentEvent(int eventType,
Document document,
Community community,
java.util.Map<java.lang.String,? extends java.lang.Object> params)
|
|
| Uses of Community in com.jivesoftware.community.widget |
|---|
| Methods in com.jivesoftware.community.widget that return Community | |
|---|---|
Community |
WidgetContext.getCommunity()
Gets the community object for this widget context, or null if the widget is being rendered outside of a community. |
| Constructors in com.jivesoftware.community.widget with parameters of type Community | |
|---|---|
WidgetContext(JiveContext jiveContext,
User user,
AuthToken authToken,
javax.servlet.http.HttpServletRequest request,
javax.servlet.http.HttpServletResponse response,
Community community)
Creates a WidgetContext with all the necessary information for a widget author to
render their widget, as well as the parent community of the widget. |
|
|
Clearspace Project Page | |||||||||
| PREV NEXT | FRAMES NO FRAMES | |||||||||