public class

DefaultJiraFirstUseFlow

extends Object
implements FirstUseFlow
java.lang.Object
   ↳ com.atlassian.jira.onboarding.basic.DefaultJiraFirstUseFlow

Summary

Public Constructors
DefaultJiraFirstUseFlow()
Public Methods
@Nonnull String getUrl()
The location (of the web action) at which the first-use flow begins.
boolean isApplicable(ApplicationUser user)
A hook point to allow a flow to check whether it would be appropriate to put the user through it.
[Expand]
Inherited Methods
From class java.lang.Object
From interface com.atlassian.jira.onboarding.FirstUseFlow

Public Constructors

public DefaultJiraFirstUseFlow ()

Public Methods

@Nonnull public String getUrl ()

The location (of the web action) at which the first-use flow begins. Any user that is eligible to be run through the flow will be directed to this URL upon logging in.

Returns
  • the URL of the flow's starting action.

public boolean isApplicable (ApplicationUser user)

A hook point to allow a flow to check whether it would be appropriate to put the user through it. For example, if you have a flow that only people with permission to create projects should go through, you could do that permission check here.

Returns
  • true if the first use flow should be activated for this user.