Package com.taskadapter.redmineapi

Class WikiManager

java.lang.Object

com.taskadapter.redmineapi.WikiManager

public class WikiManager
extends java.lang.Object

Works with Wiki entries (read-only at this moment).

Obtain it via RedmineManager:

 RedmineManager redmineManager = RedmineManagerFactory.createWithUserAuth(redmineURI, login, password);
 WikiManager wikiManager = redmineManager.getWikiManager();
 

Sample usage:

 String projectKey = "projkey1410979585758";
 wikiPages = manager.getWikiPagesByProject(projectKey);
 

See Also:

RedmineManager

Method Summary

Modifier and Type	Method	Description
void	create(java.lang.String projectKey, WikiPageDetail detail)	At this moment create() simply calls update().
WikiPageDetail	getWikiPageDetailByProjectAndTitle(java.lang.String projectKey, java.lang.String pageTitle)
java.util.List<WikiPage>	getWikiPagesByProject(java.lang.String projectKey)
void	update(java.lang.String projectKey, WikiPageDetail detail)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getWikiPagesByProject

public java.util.List<WikiPage> getWikiPagesByProject(java.lang.String projectKey)
                                               throws RedmineException

Parameters:

projectKey - the key of the project (like "TEST-12") we want the wiki pages from

Returns:

a list of all wiki pages for the project.

Throws:

RedmineException

Since:

Redmine 2.2

getWikiPageDetailByProjectAndTitle

public WikiPageDetail getWikiPageDetailByProjectAndTitle(java.lang.String projectKey,
                                                         java.lang.String pageTitle)
                                                  throws RedmineException

Parameters:

projectKey - the key of the project (like "TEST-12") we want the wiki page from

pageTitle - The name of the page

Returns:

the wiki page titled with the name passed as parameter

Throws:

RedmineException

Since:

Redmine 2.2

create

public void create(java.lang.String projectKey,
                   WikiPageDetail detail)
            throws RedmineException

At this moment create() simply calls update(). There are no differences between these two functions.

Throws:

RedmineException

update

public void update(java.lang.String projectKey,
                   WikiPageDetail detail)
            throws RedmineException

Parameters:

projectKey - the key of the project (like "TEST-12") we want the wiki page from

detail - the WikiPageDetail with its text and comment updated. Version must be set to the latest version of the document.

Throws:

RedmineException