Package com.xwiki.task.rest

Interface TaskboxResource

@Unstable
public interface TaskboxResource

Updates the checkbox macro present in a given page, identified by its id.

Since:

3.8.0

Version:

$Id$

Method Summary

Modifier and Type	Method	Description
javax.ws.rs.core.Response	changeTaskStatus(String wikiName, String spaces, String pageName, String id, String checked)	Update the status of a checkbox macro.

Method Detail

changeTaskStatus

javax.ws.rs.core.Response changeTaskStatus(String wikiName,
                                           @Encoded
                                           String spaces,
                                           String pageName,
                                           String id,
                                           String checked)
                                    throws org.xwiki.rest.XWikiRestException

Update the status of a checkbox macro.

Parameters:

wikiName - the wiki where the checkbox macro is located.

spaces - the spaces of the page where the checkbox macro is located.

pageName - the page where the checkbox macro is located.

id - the id of the checkbox that should be updated.

checked - the new status - either

Returns:

status code 200 if it succeeds.

Throws:

org.xwiki.rest.XWikiRestException - if the status of the checkbox macro could not be changed.