public class

OnboardingServiceImpl

extends Object
implements Startable OnboardingService
java.lang.Object
   ↳ com.atlassian.jira.onboarding.OnboardingServiceImpl

Summary

Public Constructors
OnboardingServiceImpl(PluginAccessor pluginAccessor, OnboardingStore store, UserChecker userChecker, LandingPageRedirectManager landingPageRedirectManager)
Public Methods
void completeFirstUseFlow(ApplicationUser user)
Mark the user as completing their first user flow
@Nullable String getCurrentFirstUseFlowSequence(ApplicationUser user)
Get the current sequence key for the flow that the user is completing.
@Nullable FirstUseFlow getFirstUseFlow(ApplicationUser user)
Checks whether the user should do an onboarding flow for the product.
@Nullable String getStartedFirstUseFlowKey(ApplicationUser user)
Get the key of the flow that the user is completing.
boolean hasCompletedFirstUseFlow(ApplicationUser user)
void setCurrentFirstUseFlowSequence(ApplicationUser user, String sequenceKey)
Assign the user as beginning a current sequence in the flow
void start()
This method will be called after the plugin system is fully initialised and all components added to the dependency injection framework.
[Expand]
Inherited Methods
From class java.lang.Object
From interface com.atlassian.jira.extension.Startable
From interface com.atlassian.jira.onboarding.OnboardingService

Public Constructors

public OnboardingServiceImpl (PluginAccessor pluginAccessor, OnboardingStore store, UserChecker userChecker, LandingPageRedirectManager landingPageRedirectManager)

Public Methods

public void completeFirstUseFlow (ApplicationUser user)

Mark the user as completing their first user flow

Parameters
user that the first flow has been completed for

@Nullable public String getCurrentFirstUseFlowSequence (ApplicationUser user)

Get the current sequence key for the flow that the user is completing.

Parameters
user that is completing flow
Returns
  • sequence key of flow

@Nullable public FirstUseFlow getFirstUseFlow (ApplicationUser user)

Checks whether the user should do an onboarding flow for the product. Returns the appropriate onboarding flow to put the user through (if any). Additionally stores a resolved user property when the onboarding was evaluated and skipped for the current user

Returns
  • a FirstUseFlow if the user is eligible for one (and hasn't done one before), null otherwise.

@Nullable public String getStartedFirstUseFlowKey (ApplicationUser user)

Get the key of the flow that the user is completing.

Parameters
user to check against
Returns
  • key or null if not doing a flow

public boolean hasCompletedFirstUseFlow (ApplicationUser user)

public void setCurrentFirstUseFlowSequence (ApplicationUser user, String sequenceKey)

Assign the user as beginning a current sequence in the flow

Parameters
user that is completing the flow
sequenceKey of the sequence being started

public void start ()

This method will be called after the plugin system is fully initialised and all components added to the dependency injection framework.