Package com.atlassian.bitbucket.help

Interface HelpPathService

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

  • Method Details

    • getPageAlt

      @Nullable String getPageAlt(@Nonnull 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

    • getPageKey

      @Nullable String getPageKey(@Nonnull 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

    • getPageTitle

      @Nullable String getPageTitle(@Nonnull 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

    • getPageUrl

      @Nullable String getPageUrl(@Nonnull 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

    • getPrefix

      @Nullable String getPrefix()
      Returns:
      the prefix url for all help topics