|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
@ExperimentalApi public interface RemoteContentLabelService
ContentLabelService
implementation that communicates with Confluence
remotely using the Confluence REST API.
Provides Promise
returning equivalents for the methods in ContentLabelService.
Method Summary | |
---|---|
com.atlassian.util.concurrent.Promise<? extends Iterable<Label>> |
addLabels(ContentId contentId,
Iterable<Label> labels)
Adds the given labels to the specified content |
com.atlassian.util.concurrent.Promise<? extends Iterable<Label>> |
getLabels(ContentId contentId,
Collection<Label.Prefix> prefixes,
PageRequest request)
Get the labels attached to a given piece of content in the given namespaces |
void |
removeLabels(ContentId contentId,
Iterable<Label> labels)
Remove a label with labelId from the specified content |
Method Detail |
---|
com.atlassian.util.concurrent.Promise<? extends Iterable<Label>> getLabels(ContentId contentId, Collection<Label.Prefix> prefixes, PageRequest request) throws NotFoundException
contentId
- the id of the content to retrieve
NotFoundException
- if the content does not exist, or is not viewable by the usercom.atlassian.util.concurrent.Promise<? extends Iterable<Label>> addLabels(ContentId contentId, Iterable<Label> labels) throws ServiceException
contentId
- the id of the content to add labels tolabels
- the label(s) that will be added
ServiceException
- if at least one label is invalid. Provides an error messagevoid removeLabels(ContentId contentId, Iterable<Label> labels) throws ServiceException
contentId
- the id of the content to remove the label fromlabels
- the labels to remove
ServiceException
- failed to remove the label
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |