|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface ConfluenceRpcService
Helper class for making XMLRPC calls to Confluence servers.
Method Summary | |
---|---|
RemoteResponse<ConfluencePage> |
getPage(com.atlassian.applinks.api.ApplicationLink applicationLink,
String pageId)
Gets the page with the given id, on the Confluence server given by the application link. |
RemoteResponse<List<ConfluenceSpace>> |
getSpaces(com.atlassian.applinks.api.ApplicationLink applicationLink)
Get the list of spaces for the Confluence instance matching the given ApplicationLink. |
RemoteResponse<List<ConfluenceSearchResult>> |
search(com.atlassian.applinks.api.ApplicationLink applicationLink,
String query,
int maxResults,
String spaceKey)
Search the Confluence instance matching the given ApplicationLink. |
Method Detail |
---|
RemoteResponse<ConfluencePage> getPage(com.atlassian.applinks.api.ApplicationLink applicationLink, String pageId) throws com.atlassian.applinks.api.CredentialsRequiredException, com.atlassian.sal.api.net.ResponseException
applicationLink
- the application link of the Confluence serverpageId
- the page id
RemoteResponse
containing a ConfluencePage
and properties of the HTTP response
com.atlassian.applinks.api.CredentialsRequiredException
- thrown if authentication is required
com.atlassian.sal.api.net.ResponseException
- thrown if the response cannot be retrievedRemoteResponse<List<ConfluenceSpace>> getSpaces(com.atlassian.applinks.api.ApplicationLink applicationLink) throws com.atlassian.applinks.api.CredentialsRequiredException, com.atlassian.sal.api.net.ResponseException
applicationLink
- the link to the Confluence instance
RemoteResponse
containing a List of ConfluenceSpace
s and properties of the HTTP response
com.atlassian.applinks.api.CredentialsRequiredException
- thrown if authentication is required
com.atlassian.sal.api.net.ResponseException
- thrown if the response cannot be retrievedRemoteResponse<List<ConfluenceSearchResult>> search(com.atlassian.applinks.api.ApplicationLink applicationLink, String query, int maxResults, @Nullable String spaceKey) throws com.atlassian.applinks.api.CredentialsRequiredException, com.atlassian.sal.api.net.ResponseException
applicationLink
- the link to the Confluence instancequery
- the search termmaxResults
- the maximum number of results to returnspaceKey
- the space to search within, or if null, search all spaces
RemoteResponse
containing a List of ConfluenceSearchResult
s and properties of the HTTP response
com.atlassian.applinks.api.CredentialsRequiredException
- thrown if authentication is required
com.atlassian.sal.api.net.ResponseException
- thrown if the response cannot be retrieved
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |