Package com.xwiki.task.rest
Interface TaskReferenceResource
-
@Unstable public interface TaskReferenceResourceProvides a way to generate task references.- Since:
- 3.1
- Version:
- $Id$
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description StringgenerateId(String wikiName, String spaces, String pageName)Generate an id for a task macro residing in a given page.
-
-
-
Method Detail
-
generateId
String generateId(String wikiName, @Encoded String spaces, String pageName) throws org.xwiki.rest.XWikiRestException
Generate an id for a task macro residing in a given page.- Parameters:
wikiName- the name of the wiki in which the page residesspaces- the spaces of the pagepageName- the name of the page- Returns:
- 200 and a serialized, unused reference of a task. The reference will either be a child or sibling to the given page, depending on the user rights.
- Throws:
org.xwiki.rest.XWikiRestException- if the generation of the reference fails. Error code 500.
-
-