@ExperimentalApi
public interface RemoteContentService
ContentService
implementation that communicates with Confluence remotely using the Confluence REST API.
Provides future returning equivalents for the methods in ContentService.
Modifier and Type | Interface and Description |
---|---|
static interface |
RemoteContentService.RemoteContentFetcher |
static interface |
RemoteContentService.RemoteContentFinder |
static interface |
RemoteContentService.RemoteParameterContentFinder |
static interface |
RemoteContentService.RemoteSingleContentFetcher |
Modifier and Type | Method and Description |
---|---|
com.atlassian.util.concurrent.Promise<Content> |
create(Content newContent)
Create a piece of content.
|
com.atlassian.util.concurrent.Promise<Content> |
create(Content newContent,
Expansion... expansions)
Create a piece of content.
|
com.atlassian.util.concurrent.Promise<Void> |
delete(Content content)
Removes an item of Content from the system.
|
RemoteContentService.RemoteContentFinder |
find(Expansion... expansions)
Create a content finder to retrieve content from the remote server
|
com.atlassian.util.concurrent.Promise<PageResponse<Content>> |
getChildren(Content parent,
PageRequest pageRequest,
Expansion... expansion)
Retrieve the children of an item of Content.
|
com.atlassian.util.concurrent.Promise<Void> |
purge(Content content)
Permanently delete a trashed piece of content.
|
com.atlassian.util.concurrent.Promise<Content> |
restore(Content content)
Restore a trashed piece of content.
|
com.atlassian.util.concurrent.Promise<Content> |
trash(Content content)
Trash a piece of content.
|
com.atlassian.util.concurrent.Promise<Content> |
update(Content content)
Updates a piece of content.
|
RemoteContentService.RemoteContentFinder find(Expansion... expansions)
com.atlassian.util.concurrent.Promise<Content> create(Content newContent)
Valid ContentRepresentation
s for the ContentBody
can be found in the documentation on the
ContentBodyConversionService
.
newContent
- the content to createServiceException
- if the content cannot be createdcom.atlassian.util.concurrent.Promise<Content> create(Content newContent, Expansion... expansions) throws ServiceException
Valid ContentRepresentation
s for the ContentBody
can be found in the documentation on the
ContentBodyConversionService
.
newContent
- the content to createexpansions
- the particular expansions will be applied to the new created contentServiceException
- if the content cannot be createdcom.atlassian.util.concurrent.Promise<Content> update(Content content)
Valid ContentRepresentation
s for the ContentBody
can be found in the documentation on the
ContentBodyConversionService
.
content
- the updated Content
with metadata about the changecom.atlassian.util.concurrent.Promise<Content> trash(Content content)
The delete(Content)
method should be used for content that doesn't support trashing.
Currently Pages and Blogposts support trashing.
content
- the content to be trashedcom.atlassian.util.concurrent.Promise<Content> restore(Content content)
content
- the content to be restoredcom.atlassian.util.concurrent.Promise<Void> purge(Content content)
content
- the content to be purgedcom.atlassian.util.concurrent.Promise<Void> delete(Content content)
content
- if of the content to removeServiceException
- if the content cannot be found, or cannot be deletedcom.atlassian.util.concurrent.Promise<PageResponse<Content>> getChildren(Content parent, PageRequest pageRequest, Expansion... expansion)
Children will be Content
items of the same type as the parent.
The pageRequest limit is restricted to a maximum page size.
parent
- - the content to retrieve the children forpageRequest
- - a pageRequest indicating how much content to retrieve.Copyright © 2003–2017 Atlassian. All rights reserved.