public class OnboardingServiceImpl extends Object implements OnboardingService, Startable
Constructor and Description |
---|
OnboardingServiceImpl(com.atlassian.plugin.PluginAccessor pluginAccessor,
OnboardingStore store,
UserChecker userChecker,
LandingPageRegistrar landingPageRegistrar) |
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.
|
public OnboardingServiceImpl(com.atlassian.plugin.PluginAccessor pluginAccessor, OnboardingStore store, UserChecker userChecker, LandingPageRegistrar landingPageRegistrar)
public boolean hasCompletedFirstUseFlow(@Nonnull ApplicationUser user)
hasCompletedFirstUseFlow
in interface OnboardingService
user
- to check againstpublic void completeFirstUseFlow(@Nonnull ApplicationUser user)
OnboardingService
completeFirstUseFlow
in interface OnboardingService
user
- that the first flow has been completed forpublic void setCurrentFirstUseFlowSequence(@Nonnull ApplicationUser user, @Nonnull String sequenceKey)
OnboardingService
setCurrentFirstUseFlowSequence
in interface OnboardingService
user
- that is completing the flowsequenceKey
- of the sequence being started@Nullable public String getCurrentFirstUseFlowSequence(@Nonnull ApplicationUser user)
OnboardingService
getCurrentFirstUseFlowSequence
in interface OnboardingService
user
- that is completing flow@Nullable public FirstUseFlow getFirstUseFlow(@Nullable ApplicationUser user)
OnboardingService
getFirstUseFlow
in interface OnboardingService
FirstUseFlow
if the user is eligible for one (and hasn't done one before), null otherwise.@Nullable public String getStartedFirstUseFlowKey(@Nonnull ApplicationUser user)
OnboardingService
getStartedFirstUseFlowKey
in interface OnboardingService
user
- to check againstCopyright © 2002-2021 Atlassian. All Rights Reserved.