com.atlassian.confluence.plugins.macros.dashboard.recentupdates.rest
Class RecentlyUpdatedContentResource
java.lang.Object
com.atlassian.confluence.plugins.macros.dashboard.recentupdates.rest.RecentlyUpdatedContentResource
public class RecentlyUpdatedContentResource
- extends Object
REST service for the RecentlyUpdatedContentMacro
- Since:
- 4.3
Method Summary |
javax.ws.rs.core.Response |
getUpdates(String tabKey,
int maxResults,
String showProfilePic,
String labelsFilter,
String spacesFilter,
String usersFilter,
String typesFilter,
String category,
String spaceKey)
Query a list of recent updates matching the given parameters. |
javax.ws.rs.core.Response |
getUpdatesPost(String tabKey,
int maxResults,
String showProfilePic,
String labelsFilter,
String spacesFilter,
String usersFilter,
String typesFilter,
String category,
String spaceKey)
We support POST in case the query string is too long for GET. |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
RecentlyUpdatedContentResource
public RecentlyUpdatedContentResource(RecentlyUpdatedContentService recentlyUpdatedContentService,
RecentlyUpdatedMacroTabProvider tabProvider,
LabelManager labelManager)
getUpdates
public javax.ws.rs.core.Response getUpdates(String tabKey,
int maxResults,
String showProfilePic,
String labelsFilter,
String spacesFilter,
String usersFilter,
String typesFilter,
String category,
String spaceKey)
throws Exception
- Query a list of recent updates matching the given parameters.
- Parameters:
tabKey
- The value from the tab's getName methodmaxResults
- The maximum number of results to return (number of RecentUpdate, not RecentUpdateGroup objects)
- Returns:
- JSON representation of a list of RecentUpdateGroup objects
- Throws:
InvalidSearchException
- If the search failed
Exception
getUpdatesPost
public javax.ws.rs.core.Response getUpdatesPost(String tabKey,
int maxResults,
String showProfilePic,
String labelsFilter,
String spacesFilter,
String usersFilter,
String typesFilter,
String category,
String spaceKey)
throws Exception
- We support POST in case the query string is too long for GET.
- Parameters:
tabKey
- The value from the tab's getName methodmaxResults
- The maximum number of results to return (number of RecentUpdate, not RecentUpdateGroup objects)
- Returns:
- JSON representation of a list of RecentUpdateGroup objects
- Throws:
InvalidSearchException
- If the search failed
Exception
Copyright © 2003-2013 Atlassian. All Rights Reserved.