Skip to content

Welcome Screen Store

WelcomeScreenStoreStep persists/rereads/erases the configuration data provided by the WelcomeScreenStep.

This step has to be executed after successful initialization of the secure store. This means that there is no secure store (except the passcodePolicyStore provided by the app developer) in the onboarding flow before the execution of the SecureStoreStep.

(The iOS equivalent is WelcomeScreenStep.swift.)

Input Parameter

Mandatory input parameters:

  • application store – Properly initialized and opened secure store implementation typically provided by the StoreManagerStep. This store should be accessed using the getApplicationStore method of the OnboardingContext.

  • context – Specifies the android context initiating the flow such as the caller Activity. This setting has to be provided on the initial FlowContext.

Output Parameters

The output of the step is always in the application store.

Using WelcomeScreenStoreStep

  1. Set the application store in the flowContext.

    1
      flowContext.setApplicationStore(secureStore);
    
  2. Initiate the step:

    1
      WelcomeScreenStoreStep welcomeScreenStoreStep = new WelcomeScreenStoreStep();
    
  3. Specify the execute method's FlowActionHandler parameter's "onFailure" and "onSuccess" behaviour:

     1
     2
     3
     4
     5
     6
     7
     8
     9
    10
    11
    12
        flowManagerService.execute(flow, flowContext, new FlowActionHandler() {
            @Override
            public void onFailure(Throwable t) {
                //set the status, update the caller activity
            }
    
            @Override
            public void onSuccess(FlowContext result) {
                //set the status, update the caller activity
                //read the result
            }
        });
    

Behaviour of WelcomeScreenStoreStep

This step writes/reads/deletes the configuration data in the application store.