com.atlassian.jira.onboarding

Class OnboardingServiceImpl

java.lang.Object

com.atlassian.jira.onboarding.OnboardingServiceImpl

All Implemented Interfaces:

Startable, OnboardingService

public class OnboardingServiceImpl
extends Object
implements OnboardingService, Startable

Constructor Summary

Constructors

Constructor and Description
OnboardingServiceImpl(com.atlassian.plugin.PluginAccessor pluginAccessor, OnboardingStore store, UserChecker userChecker, LandingPageRegistrar landingPageRegistrar)

Method Summary

Modifier and Type	Method and Description
void	completeFirstUseFlow(ApplicationUser user) Mark the user as completing their first user flow
String	getCurrentFirstUseFlowSequence(ApplicationUser user) Get the current sequence key for the flow that the user is completing.
FirstUseFlow	getFirstUseFlow(ApplicationUser user) Checks whether the user should do an onboarding flow for the product.
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.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

OnboardingServiceImpl

public OnboardingServiceImpl(com.atlassian.plugin.PluginAccessor pluginAccessor,
                             OnboardingStore store,
                             UserChecker userChecker,
                             LandingPageRegistrar landingPageRegistrar)

Method Detail

hasCompletedFirstUseFlow

public boolean hasCompletedFirstUseFlow(@Nonnull
                                        ApplicationUser user)

Specified by:

hasCompletedFirstUseFlow in interface OnboardingService

Parameters:

user - to check against

Returns:

whether a user has already completed a first user flow.

completeFirstUseFlow

public void completeFirstUseFlow(@Nonnull
                                 ApplicationUser user)

Description copied from interface: OnboardingService

Mark the user as completing their first user flow

Specified by:

completeFirstUseFlow in interface OnboardingService

Parameters:

user - that the first flow has been completed for

setCurrentFirstUseFlowSequence

public void setCurrentFirstUseFlowSequence(@Nonnull
                                           ApplicationUser user,
                                           @Nonnull
                                           String sequenceKey)

Description copied from interface: OnboardingService

Assign the user as beginning a current sequence in the flow

Specified by:

setCurrentFirstUseFlowSequence in interface OnboardingService

Parameters:

user - that is completing the flow

sequenceKey - of the sequence being started

getCurrentFirstUseFlowSequence

@Nullable
public String getCurrentFirstUseFlowSequence(@Nonnull
                                                       ApplicationUser user)

Description copied from interface: OnboardingService

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

Specified by:

getCurrentFirstUseFlowSequence in interface OnboardingService

Parameters:

user - that is completing flow

Returns:

sequence key of flow

getFirstUseFlow

@Nullable
public FirstUseFlow getFirstUseFlow(@Nullable
                                              ApplicationUser user)

Description copied from interface: OnboardingService

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

Specified by:

getFirstUseFlow in interface OnboardingService

Returns:

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

getStartedFirstUseFlowKey

@Nullable
public String getStartedFirstUseFlowKey(@Nonnull
                                                  ApplicationUser user)

Description copied from interface: OnboardingService

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

Specified by:

getStartedFirstUseFlowKey in interface OnboardingService

Parameters:

user - to check against

Returns:

key or null if not doing a flow

start

public void start()

Description copied from interface: Startable

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

Specified by:

start in interface Startable