public interface

HelpPathService

com.atlassian.stash.help.HelpPathService

Class Overview

A service for retrieving Stash help urls and related help information for a given help topic.

Summary

Public Methods
String getPageAlt(String topicKey)
String getPageKey(String topicKey)
String getPageTitle(String topicKey)
String getPageUrl(String topicKey)
String getPrefix()

Public Methods

public String getPageAlt (String topicKey)

Parameters
topicKey the non-null key for the help topic
Returns
  • the alt (tool tip) to be displayed for the help topic or null if one was not found for the help topic

public String getPageKey (String topicKey)

Parameters
topicKey the non-null key for the help topic
Returns
  • the Confluence page key for the help topic or null if one was not found for the help topic

public String getPageTitle (String topicKey)

Parameters
topicKey the non-null key for the help topic
Returns
  • the title to be displayed for the help topic or null if one was not found for the help topic

public String getPageUrl (String topicKey)

Parameters
topicKey the non-null key for the help topic
Returns
  • the url for the help topic or null if one was not found for the help topic

public String getPrefix ()

Returns
  • the prefix url for all help topics