com.atlassian.confluence.api.nav

Interface Navigation

All Known Subinterfaces:

RestNavigation

All Known Implementing Classes:

RestNavigationImpl

@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

Nested Classes

Modifier and Type	Interface and Description
static interface	Navigation.Builder
static interface	Navigation.ContentNav
static interface	Navigation.ContentRestrictionByOperationNav
static interface	Navigation.ExperimentalContentNav ExperimentalContentNav will change as new resources are added and promoted to production.
static interface	Navigation.ExperimentalContentTemplateNav
static interface	Navigation.ExperimentalNav ExperimentalNav will change as new resources are added and promoted to production.
static interface	Navigation.GroupNav
static interface	Navigation.LongTaskNav
static interface	Navigation.SpaceContentNav
static interface	Navigation.SpaceNav
static interface	Navigation.UserNav

Method Summary

Modifier and Type	Method and Description
Navigation.Builder	baseApiPath()
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) Deprecated. since 5.10 Use content(ContentSelector).
Navigation.ContentNav	content(ContentSelector selector) Create a content nav builder to reference a piece of content with a particular id, status and version.
Navigation.ContentNav	content(Reference<Content> contentReference) create a content nav builder to reference a piece of content
String	contextPath()
Navigation.ExperimentalNav	experimental()
Navigation.Builder	fromReference(Reference<?> reference)
Navigation.GroupNav	group(Group group) a builder to produce a url to a user group
Navigation.LongTaskNav	longTask(LongTaskId id)
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
Navigation.UserNav	user(com.atlassian.sal.api.user.UserKey userKey) create a user nav builder to reference the user with the given user key

Method Detail

experimental

Navigation.ExperimentalNav experimental()

content

Navigation.ContentNav content(Content content)

create a content nav builder to reference a piece of content

content

Navigation.ContentNav content(Reference<Content> contentReference)

create a content nav builder to reference a piece of content

content

@Deprecated
Navigation.ContentNav content(ContentId contentId)

Deprecated. since 5.10 Use content(ContentSelector).

create a content nav builder to reference a piece of content

content

Navigation.ContentNav content(ContentSelector selector)

Create a content nav builder to reference a piece of content with a particular id, status and version.

space

Navigation.SpaceNav space(Reference<Space> spaceReference)

create a space nav builder to reference the given space

user

Navigation.UserNav user(com.atlassian.sal.api.user.UserKey userKey)

create a user nav builder to reference the user with the given user key

Parameters:

userKey -

Returns:

collection

Navigation.Builder collection(Content content)

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

collection

Navigation.Builder collection(Space space)

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

space

Navigation.SpaceNav space(Space space)

create a space nav builder to reference the given space

longTask

Navigation.LongTaskNav longTask(LongTaskId id)

group

Navigation.GroupNav group(Group group)

a builder to produce a url to a user group

contextPath

String contextPath()

baseUrl

String baseUrl()

baseApiPath

Navigation.Builder baseApiPath()

fromReference

Navigation.Builder fromReference(Reference<?> reference)