JBoss.orgCommunity Documentation
The Forum application of eXo Knowledge uses the ForumWebservice to provide all APIs to work with Forum, such as filtering IPs, viewing RSS, and more.
| Service name | Service URL | Description | Location |
|---|---|---|---|
| ForumWebservice | $portalName/ $restcontextname/ ks/forum/ | Call extended services of the Forum application. |
* Maven groupId: org.exoplatform.ks * ArtifactId: exo.ks.web.webservice |
APIs Usage
Use the following APIs to build all the functions of the Forum application:
| Name | Description | Service URL endpoint | Parameters | Expected values |
|---|---|---|---|---|
| getMessage | Get all new posts with the number based on the maxcount value. | $portalName/ $restcontextname/ ks/forum/getmessage/ | String maxcount | integer |
| filterIps | Ban IPs with no access to Forum. | $portalName/ $restcontextname/ ks/forum/filter/ | String str | String in the IP format. |
| filterIpBanForum | Ban IPs with no access to a specific Forum. | $portalName/ $restcontextname/ ks/forum/ filterIpBanforum/ |
String forumId String str | string in the IP format, string in the Forum format |
| filterTagNameForum | Do the quick search for tags that returns the list of tags. | $portalName/ $restcontextname/ ks/forum/ filterTagNameForum/ |
String str String userAndTopicId |
Tag name id of user and topic |
| viewrss | Process the request by users when they want to view RSS. | $portalName/ $restcontextname/ ks/forum/rss/ | String resourceid |
category id forum id topic id |
| userrss | Process the request by users when they want to view their own collected RSS. | $portalName /$restcontextname/ ks/forum/rss/user/ | String resourceid | username id |