Package com.atlassian.jira.hints
Interface HintManager
- All Known Implementing Classes:
DefaultHintManager
public interface HintManager
Hint manager responsible for providing JIRA usage hints displayed
to the users.
- Since:
- v4.2
-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic enum
A number of different contexts that hints may be displayed for. -
Method Summary
Modifier and TypeMethodDescriptiongetAllHints
(ApplicationUser user, JiraHelper helper) Get all hints visible in given user context.getHintForContext
(ApplicationUser remoteUser, JiraHelper jiraHelper, HintManager.Context context) Given a validHintManager.Context
this method returns a random link for that context.getRandomHint
(ApplicationUser user, JiraHelper jiraHelper) Get random hint visible in given user context.
-
Method Details
-
getRandomHint
Get random hint visible in given user context.- Parameters:
user
- current userjiraHelper
- JIRA helper- Returns:
- random hint
-
getAllHints
Get all hints visible in given user context.- Parameters:
user
- current userhelper
- JIRA helper- Returns:
- all hints accessible to the user
-
getHintForContext
Hint getHintForContext(ApplicationUser remoteUser, JiraHelper jiraHelper, HintManager.Context context) Given a validHintManager.Context
this method returns a random link for that context. May be null if no hints exist for the context specified.- Parameters:
remoteUser
- The current userjiraHelper
- JIRA helpercontext
- The context to display a hint for- Returns:
- A random hint for the context specified or null if none exist
-