Package com.atlassian.confluence.api.service.content

Interface SpaceLabelService

All Known Implementing Classes:

SpaceLabelServiceImpl

public interface SpaceLabelService

Provides operations for Space labels.

Since:

9.1

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	SpaceLabelService.Validator	Provides methods for validating create, update and delete methods.

Method Summary

Modifier and Type	Method	Description
PageResponse<Label>	findAllContentLabelsPaginated(String spaceKey, PageRequest pageRequest)	Returns a paginated list of all Labels used by Content within the given Space.
PageResponse<Label>	findPopularContentLabelsPaginated(String spaceKey, PageRequest pageRequest)	Returns a paginated list of the most popular Labels used by Content within the given Space.
PageResponse<Label>	findRecentContentLabelsPaginated(String spaceKey, PageRequest pageRequest)	Returns a paginated list of the most recent Labels used by Content within the given Space.
PageResponse<Label>	findRelatedContentLabelsPaginated(String spaceKey, String labelName, PageRequest pageRequest)	Returns a paginated list of related Labels used by Content within the given Space.
SpaceLabelService.Validator	validator()	Get the validator view of the Space Service.

Method Details

findAllContentLabelsPaginated

PageResponse<Label> findAllContentLabelsPaginated(String spaceKey,
 PageRequest pageRequest)

Returns a paginated list of all Labels used by Content within the given Space.

Parameters:

spaceKey - the key of the Space the User is attempting to search.

pageRequest - the pagination parameters.

Returns:

Paginated list of labels.

Since:

9.1.0

findPopularContentLabelsPaginated

PageResponse<Label> findPopularContentLabelsPaginated(String spaceKey,
 PageRequest pageRequest)

Returns a paginated list of the most popular Labels used by Content within the given Space.

Parameters:

spaceKey - the key of the Space the User is attempting to search.

pageRequest - the pagination parameters.

Returns:

Paginated list of labels.

Since:

9.1.0

findRecentContentLabelsPaginated

PageResponse<Label> findRecentContentLabelsPaginated(String spaceKey,
 PageRequest pageRequest)

Returns a paginated list of the most recent Labels used by Content within the given Space.

Parameters:

spaceKey - the key of the Space the User is attempting to search.

pageRequest - the pagination parameters.

Returns:

Paginated list of labels.

Since:

9.1.0

findRelatedContentLabelsPaginated

PageResponse<Label> findRelatedContentLabelsPaginated(String spaceKey,
 String labelName,
 PageRequest pageRequest)

Returns a paginated list of related Labels used by Content within the given Space. A Label is defined as being related to another when it is found attached to the same Content as the Label specified in the request.

Parameters:

spaceKey - the key of the Space the User is attempting to search.

labelName - the Label to match on.

pageRequest - the pagination parameters.

Returns:

Paginated list of labels.

Since:

9.1.0

validator

SpaceLabelService.Validator validator()

Get the validator view of the Space Service.