Package com.atlassian.jira.help

Interface HelpUrl

All Known Implementing Classes:
MockHelpUrl
@ExperimentalApi public interface HelpUrl
Represents the URL of a Jira help page. The URL can point to a page within the current Jira instance (e.g. isLocal() == true) or to a page hosted on an external site.
Since:
v6.2.4

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getAlt()
    The alternate text for the URL.
    String
    getDescription()
    The description text for the URL.
    String
    getKey()
    The key the URL is registered under.
    String
    getTitle()
    The title for the URL.
    String
    getUrl()
    The URL for the help.
    boolean
    isLocal()
    Indicates if the URL is for Jira internal help (i.e.

  • Method Details

    • getUrl

      String getUrl()
      The URL for the help.
      Returns:
      the URL for the help.

    • getAlt

      String getAlt()
      The alternate text for the URL.
      Returns:
      The alternate text for the URL.

    • getDescription

      String getDescription()
      The description text for the URL.
      Returns:
      The description text for the URL.

    • getTitle

      String getTitle()
      The title for the URL.
      Returns:
      The title for the URL.

    • getKey

      String getKey()
      The key the URL is registered under.
      Returns:
      the key the URL is registered under.

    • isLocal

      boolean isLocal()
      Indicates if the URL is for Jira internal help (i.e. help page served by Jira).
      Returns:
      true when the URL is designed to be served by Jira or false otherwise.