Cookie Notice

Use Tree Navigation
public interface

HelpPathService

com.atlassian.bitbucket.help.HelpPathService

Class Overview

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

Summary

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

Public Methods

@Nullable 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

@Nullable 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

@Nullable 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

@Nullable 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

@Nullable public String getPrefix ()

Returns
  • the prefix url for all help topics
Feedback?
View cookie preferences