com.atlassian.confluence.api.nav
Interface Navigation

All Known Subinterfaces:

RestNavigation

All Known Implementing Classes:

NavigationImpl

@ExperimentalApi
public interface Navigation

NavBuilder facilitates building URLs from our model objects. Inject NavBuilderService into your component and use that to create instances of a NavBuilder

Nested Class Summary

static interface	Navigation.Builder
static interface	Navigation.ContentNav
static interface	Navigation.SpaceContentNav
static interface	Navigation.SpaceNav

Method Summary

Navigation.Builder	baseApiPath()
java.lang.String	baseUrl()
Navigation.Builder	collection(Content content) a builder to produce a URL to the collection that the content belongs to.
Navigation.Builder	collection(Space space) a builder to produce a URL to the collection that the space belongs to.
Navigation.ContentNav	content(Content content) create a content nav builder to reference a piece of content
Navigation.ContentNav	content(ContentId contentId) create a content nav builder to reference a piece of content
Navigation.ContentNav	content(Reference<Content> contentReference) create a content nav builder to reference a piece of content
Navigation.Builder	fromReference(Reference<?> reference)
Navigation.SpaceNav	space(Reference<Space> spaceReference) create a space nav builder to reference the given space
Navigation.SpaceNav	space(Space space) create a space nav builder to reference the given space

Method Detail

content

Navigation.ContentNav content(Content content)

create a content nav builder to reference a piece of content

Parameters:

content -

Returns:

content

Navigation.ContentNav content(Reference<Content> contentReference)

create a content nav builder to reference a piece of content

Parameters:

contentReference -

Returns:

content

Navigation.ContentNav content(ContentId contentId)

create a content nav builder to reference a piece of content

Parameters:

contentId -

Returns:

space

Navigation.SpaceNav space(Reference<Space> spaceReference)

create a space nav builder to reference the given space

Parameters:

spaceReference -

Returns:

collection

Navigation.Builder collection(Content content)

a builder to produce a URL to the collection that the content belongs to.

Parameters:

content -

Returns:

collection

Navigation.Builder collection(Space space)

a builder to produce a URL to the collection that the space belongs to.

Parameters:

space -

Returns:

space

Navigation.SpaceNav space(Space space)

create a space nav builder to reference the given space

Parameters:

space -

Returns:

baseUrl

java.lang.String baseUrl()

baseApiPath

Navigation.Builder baseApiPath()

fromReference

Navigation.Builder fromReference(Reference<?> reference)