public interface IWikiAppSoap
Modifier and Type | Method and Description |
---|---|
void |
addAttachment(String sessionId,
String wikiPageId,
String fileId,
String filename,
String mimetype)
Attaches the uploaded file to the specified wiki page.
|
void |
addAttachments(String sessionId,
String wikiPageId,
AttachmentSoapDO[] attachments)
Attaches the uploaded file to the specified wiki page.
|
WikiPageSoapDO |
createWikiPage(String sessionId,
String projectId,
String name,
String wikiText,
String versionComment)
Creates a new wiki page with the specified name, text, etc.
|
void |
deleteWikiPage(String sessionId,
String wikiPageId)
Deletes a wiki page.
|
String |
getFormattedWikiPageText(String sessionId,
String wikiPageId)
Gets specified wiki page text in formatted (HTML) form.
|
WikiPageSoapDO |
getWikiPageData(String sessionId,
String wikiPageId)
Gets specified wiki page data.
|
WikiPageSoapDO |
getWikiPageDataByName(String sessionId,
String projectId,
String wikiPageName)
Gets specified wiki page text in formatted (HTML) form.
|
WikiPageSoapList |
getWikiPageList(String sessionId,
String projectId)
Lists all wiki pages that have contents within a project.
|
void |
setWikiPageData(String sessionId,
WikiPageSoapDO wikiPageData)
Sets specified wiki page data.
|
WikiPageSoapDO createWikiPage(String sessionId, String projectId, String name, String wikiText, String versionComment) throws RemoteException
sessionId
- SOAP session id.projectId
- Project in which to create a wiki page.name
- Wiki page name.wikiText
- Wiki text for the page.versionComment
- Wiki page version comment.com.collabnet.ce.soap60.fault.InvalidSessionFault
- when the sessionId is invalid.com.collabnet.ce.soap60.fault.PermissionDeniedFault
- when permission is denied for the specified operation.com.collabnet.ce.soap60.fault.NoSuchObjectFault
- when the specified object is invalid.com.collabnet.ce.soap60.fault.IllegalArgumentFault
- when one or more of the parameters are invalid.com.collabnet.ce.soap60.fault.ObjectAlreadyExistsFault
- when a page with the specified name already exists in the projectcom.collabnet.ce.soap60.fault.SystemFault
- when an unexpected system error occurs.RemoteException
void deleteWikiPage(String sessionId, String wikiPageId) throws RemoteException
sessionId
- User session id.wikiPageId
- Wiki page id.com.collabnet.ce.soap60.fault.InvalidSessionFault
- when the sessionId is invalid.com.collabnet.ce.soap60.fault.PermissionDeniedFault
- when permission is denied for the specified operation.com.collabnet.ce.soap60.fault.NoSuchObjectFault
- when the specified object is invalid.com.collabnet.ce.soap60.fault.SystemFault
- when an unexpected system error occurs.RemoteException
WikiPageSoapDO getWikiPageData(String sessionId, String wikiPageId) throws RemoteException
sessionId
- User session id.wikiPageId
- Wiki page id.com.collabnet.ce.soap60.fault.IllegalArgumentFault
- when the method argument(s) are invalidcom.collabnet.ce.soap60.fault.InvalidSessionFault
- when the sessionId is invalid.com.collabnet.ce.soap60.fault.PermissionDeniedFault
- when permission is denied for the specified operation.com.collabnet.ce.soap60.fault.NoSuchObjectFault
- when the specified object is invalid.com.collabnet.ce.soap60.fault.SystemFault
- when an unexpected system error occurs.RemoteException
String getFormattedWikiPageText(String sessionId, String wikiPageId) throws RemoteException
sessionId
- User session id.wikiPageId
- Wiki page id.com.collabnet.ce.soap60.fault.IllegalArgumentFault
- when the method argument(s) are invalidcom.collabnet.ce.soap60.fault.InvalidSessionFault
- when the sessionId is invalid.com.collabnet.ce.soap60.fault.PermissionDeniedFault
- when permission is denied for the specified operation.com.collabnet.ce.soap60.fault.NoSuchObjectFault
- when the specified object is invalid.com.collabnet.ce.soap60.fault.SystemFault
- when an unexpected system error occurs.RemoteException
WikiPageSoapDO getWikiPageDataByName(String sessionId, String projectId, String wikiPageName) throws RemoteException
sessionId
- User session id.projectId
- Project id.wikiPageName
- Name of the wiki page.com.collabnet.ce.soap60.fault.IllegalArgumentFault
- when the method argument(s) are invalidcom.collabnet.ce.soap60.fault.InvalidSessionFault
- when the sessionId is invalid.com.collabnet.ce.soap60.fault.PermissionDeniedFault
- when permission is denied for the specified operation.com.collabnet.ce.soap60.fault.NoSuchObjectFault
- when the specified object is invalid.com.collabnet.ce.soap60.fault.SystemFault
- when an unexpected system error occurs.RemoteException
WikiPageSoapList getWikiPageList(String sessionId, String projectId) throws RemoteException
sessionId
- User session id.projectId
- Project id.com.collabnet.ce.soap60.fault.IllegalArgumentFault
- when the method argument(s) are invalidcom.collabnet.ce.soap60.fault.InvalidSessionFault
- when the sessionId is invalid.com.collabnet.ce.soap60.fault.PermissionDeniedFault
- when permission is denied for the specified operation.com.collabnet.ce.soap60.fault.NoSuchObjectFault
- when the specified object is invalid.com.collabnet.ce.soap60.fault.SystemFault
- when an unexpected system error occurs.RemoteException
void setWikiPageData(String sessionId, WikiPageSoapDO wikiPageData) throws RemoteException
sessionId
- User session id.wikiPageData
- Wiki page data object.com.collabnet.ce.soap60.fault.InvalidSessionFault
- when the sessionId is invalid.com.collabnet.ce.soap60.fault.PermissionDeniedFault
- when permission is denied for the specified operation.com.collabnet.ce.soap60.fault.NoSuchObjectFault
- when the specified object is invalid.com.collabnet.ce.soap60.fault.IllegalArgumentFault
- when wiki page data information is invalid.com.collabnet.ce.soap60.fault.VersionMismatchFault
- when wiki page data is stale.com.collabnet.ce.soap60.fault.SystemFault
- when an unexpected system error occurs.RemoteException
void addAttachment(String sessionId, String wikiPageId, String fileId, String filename, String mimetype) throws RemoteException
sessionId
- User session id.wikiPageId
- Wiki page id.fileId
- Attachment file ID returned by FileStorageApp/SimpleFileStorageApp webservice.filename
- Attachment file name.mimetype
- Attachment file type.com.collabnet.ce.soap60.fault.InvalidSessionFault
- when the sessionId is invalid.com.collabnet.ce.soap60.fault.PermissionDeniedFault
- when permission is denied for the specified operation.com.collabnet.ce.soap60.fault.NoSuchObjectFault
- when the specified object is invalid.com.collabnet.ce.soap60.fault.NoSuchVersionFault
- when the specified version is invalid.com.collabnet.ce.soap60.fault.SystemFault
- when an unexpected system error occurs.RemoteException
void addAttachments(String sessionId, String wikiPageId, AttachmentSoapDO[] attachments) throws RemoteException
sessionId
- User session id.wikiPageId
- Wiki page id.attachments
- AttachmentSoapDO.com.collabnet.ce.soap60.fault.InvalidSessionFault
- when the sessionId is invalid.com.collabnet.ce.soap60.fault.PermissionDeniedFault
- when permission is denied for the specified operation.com.collabnet.ce.soap60.fault.NoSuchObjectFault
- when the specified object is invalid.com.collabnet.ce.soap60.fault.NoSuchVersionFault
- when the specified version is invalid.com.collabnet.ce.soap60.fault.SystemFault
- when an unexpected system error occurs.RemoteException
Copyright © 2016 CollabNet. All Rights Reserved.