public interface

DocumentationLinker

com.atlassian.applinks.core.docs.DocumentationLinker
Known Indirect Subclasses

Class Overview

Provides URIs for UAL documentation.

Summary

Public Methods
abstract URI getLink(String pageKey)
abstract URI getLink(String pageKey, String sectionKey)

Public Methods

public abstract URI getLink (String pageKey)

Parameters
pageKey a key matching a help page property defined in ual-help-paths.properties
Returns
  • a URI targeting the specified help page in the host application's documentation space

public abstract URI getLink (String pageKey, String sectionKey)

Parameters
pageKey a key matching a help page property defined in ual-help-paths.properties
sectionKey a key matching a help page anchor property defined in ual-help-paths.properties
Returns
  • a URI targeting the specified help page in the host application's documentation space