com.atlassian.confluence.rest.client
Interface RemoteContentTrashService

All Known Implementing Classes:

RemoteContentTrashServiceImpl

@ExperimentalApi
public interface RemoteContentTrashService

ContentTrashService implementation that communicates with Confluence remotely using the Confluence REST API. Provides Promise-returning equivalents for the methods in ContentTrashService.

Method Summary

com.atlassian.util.concurrent.Promise<Void>	purge(Content content) Permanently delete a piece of content.
com.atlassian.util.concurrent.Promise<Content>	restore(Content content) Restore a trashed piece of content.
com.atlassian.util.concurrent.Promise<Void>	trash(Content content) Trash a piece of content.

Method Detail

trash

com.atlassian.util.concurrent.Promise<Void> trash(Content content)

Trash a piece of content.

The purge(Content) method can be used for content that doesn't support trashing. Currently, only content with types ContentType.PAGE and ContentType.BLOG_POST support trashing.

Parameters:

content - the content to be trashed

Returns:

the content after being trashed

restore

com.atlassian.util.concurrent.Promise<Content> restore(Content content)

Restore a trashed piece of content.

Parameters:

content - the content to be restored

Returns:

the content after being restored

purge

com.atlassian.util.concurrent.Promise<Void> purge(Content content)

Permanently delete a piece of content.

There are two main cases:

• Trashable content (e.g. Pages, BlogPosts) must have status "trashed" to be purged.
• Non-trashable content (e.g. Comments, Attachment) can be purged with status "current".

Parameters:

content - the content to be purged