Package com.atlassian.sal.api.message

Interface HelpPathResolver

public interface HelpPathResolver
Help path resolver used to retrieve product specific help. Plugins used with multiple Atlassian products may wish to have help integrated with the core product help, e.g. The administration plugin for embedded crowd directory management has different facilities in JIRA and Confluence and both JIRA and Confluence supply their own help pages for the plugin.
Since:
2.4

  • Method Summary

    Modifier and Type
    Method
    Description
    HelpPath
    getHelpPath(String key)
    Retrieve the help path for a key.

  • Method Details

    • getHelpPath

      HelpPath getHelpPath(String key)
      Retrieve the help path for a key. Implementers may choose to return null if no help is available for the given key.
      Parameters:
      key - Key to the help path. The key passed in may be null.
      Returns:
      HelpPath for the key.