public interface

HintManager

com.atlassian.jira.hints.HintManager
Known Indirect Subclasses

Class Overview

Hint manager responsible for providing JIRA usage hints displayed to the users.

Summary

Nested Classes
enum HintManager.Context A number of different contexts that hints may be displayed for. 
Public Methods
List<Hint> getAllHints(ApplicationUser user, JiraHelper helper)
Get all hints visible in given user context.
Hint getHintForContext(ApplicationUser remoteUser, JiraHelper jiraHelper, HintManager.Context context)
Given a valid HintManager.Context this method returns a random link for that context.
Hint getRandomHint(ApplicationUser user, JiraHelper jiraHelper)
Get random hint visible in given user context.

Public Methods

public List<Hint> getAllHints (ApplicationUser user, JiraHelper helper)

Get all hints visible in given user context.

Parameters
user current user
helper JIRA helper
Returns
  • all hints accessible to the user

public Hint getHintForContext (ApplicationUser remoteUser, JiraHelper jiraHelper, HintManager.Context context)

Given a valid HintManager.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 user
jiraHelper JIRA helper
context The context to display a hint for
Returns
  • A random hint for the context specified or null if none exist

public Hint getRandomHint (ApplicationUser user, JiraHelper jiraHelper)

Get random hint visible in given user context.

Parameters
user current user
jiraHelper JIRA helper
Returns
  • random hint