Restore, Reset and Logout Applications Using the Flows Component

Open the project you previously created using the SAP BTP SDK Wizard for Android.

In Android Studio, on Windows, press Ctrl+N, or, on a Mac, press command+O, and type WelcomeActivity to open WelcomeActivity.kt.

On Windows, press Ctrl+F12, or, on a Mac, press command+F12, and type startOnboarding to move to the startOnboarding method. As we mentioned in Get Familiar with the Flows Component by a Wizard Generated Application, this method starts an onboarding flow. After onboarding, the next time the app starts, the same method is called and the Flows component detects that the user is already onboarded and starts the restore flow. The client code does not need handle the logic to explicitly start a restore flow.

!

The restore flow will notify the same events as the onboarding flow and one additional UnlockWithPasscode event, which is specific to the restore flow. When the app is unlocked using a passcode, the client code can get the passcode from the onUnlockWithPasscode callback of the FlowStateListener instance and open the secure store. Customize the Onboarding Flow explains the events notified in the onboarding flow.

When the app is put to background, the Flows component will monitor whether the passcode is timed out based on the “Lock Timeout” value defined in the passcode policy. When the passcode is timed out and the app is put to foreground again, a timeout unlock flow will be started. This is the FlowType.TIMEOUT_UNLOCK flow type, which is used internally by the Flows component for the passcode timeout scenario. This flow’s function is exactly the same as that of the restore flow.

Open the project you previously created using the SAP BTP SDK Wizard for Android.

In Android Studio, on Windows, press Ctrl+N, or, on a Mac, press command+O, and type WelcomeActivity to open WelcomeActivity.java.

On Windows, press Ctrl+F12, or, on a Mac, press command+F12, and type startFlow to move to the startFlow method. As we mentioned in Get Familiar with the Flows Component by a Wizard Generated Application, this method starts an onboarding flow. After onboarding, the next time the app starts, the same method is called and the Flows component detects that the user is already onboarded and starts the restore flow. The client code does not need handle the logic to explicitly start a restore flow.

!

The restore flow will notify the same events as the onboarding flow and one additional UnlockWithPasscode event, which is specific to the restore flow. When the app is unlocked using a passcode, the client code can get the passcode from the onUnlockWithPasscode callback of the FlowStateListener instance and open the secure store. Customize the Onboarding Flow explains the events notified in the onboarding flow.

When the app is put to background, the Flows component will monitor whether the passcode is timed out based on the “Lock Timeout” value defined in the passcode policy. When the passcode is timed out and the app is put to foreground again, a timeout unlock flow will be started. This is the FlowType.TIMEOUT_UNLOCK flow type, which is used internally by the Flows component for the passcode timeout scenario. This flow’s function is exactly the same as that of the restore flow.

Open the project you previously created using the SAP BTP SDK Wizard for Android.

In Android Studio, on Windows, press Ctrl+N, or, on a Mac, press command+O, and type SettingsFragment to open SettingsFragment.kt.

On Windows, press Ctrl+F12, or, on a Mac, press command+F12, and type startResetFlow to move to the startResetFlow method. To start the flow to reset application, set the flow type to FlowType.RESET for the FlowContext instance, and then start the flow with this FlowContext instance. The entire process to reset the application will be handled automatically.

!

When the reset flow is started, the default behavior is for a dialog to be displayed, asking the user for confirmation.

!

You can customize your client code so that the reset flow hides this dialog by setting the value of needConfirmWhenReset parameter to false for the FlowOptions instance and set this FlowOptions instance for the FlowContext instance to start the reset flow.

val flowContext =
        FlowContextBuilder()
                .setFlowType(FlowType.RESET)
                .setFlowOptions(FlowOptions(
                        needConfirmWhenReset = false
                ))
                .build()
Flow.start(this, flowContext)

Before removing all the data managed by the Flows component, the reset flow will notify the ApplicationReset event. You can use the onApplicationReset callback of the FlowStateListener instance to insert its own logic for application reset, for example to clear the data managed by the client code and un-register the push token.

In Android Studio, on Windows, press Ctrl+N, or, on a Mac, press command+O, and type WizardFlowStateListener to open WizardFlowStateListener.kt. On Windows, press Ctrl+F12, or, on a Mac, press command+F12, and type onApplicationReset to move to the onApplicationReset method.

!

Open the project you previously created using the SAP BTP SDK Wizard for Android.

In Android Studio, on Windows, press Ctrl+N, or, on a Mac, press command+O, and type SettingsFragment to open SettingsFragment.java.

On Windows, press Ctrl+F12, or, on a Mac, press command+F12, and type onCreatePreferences to move to the onCreatePreferences method. To start the flow to reset the application, set the flow type to FlowType.RESET for the FlowContext instance, and then start the flow with this FlowContext instance. The entire process to reset application will be handled automatically.

!

When the reset flow is started, the default behavior, is for a dialog to be displayed, asking the user for confirmation.

!

You can customize your client code so that the reset flow hides this dialog by overriding the isResetConfirmationNeeded function of the FlowOptions instance to return false and set this FlowOptions instance for the FlowContext instance to start the reset flow.

FlowContext flowContext = new FlowContextBuilder()
            .setFlowType(FlowType.RESET)
            .setFlowOptions(new FlowOptions(){
                @Override
                public boolean isResetConfirmationNeeded() {
                    return false;
                }
            }).build();
Flow.start(this, flowContext);

Before removing all the data managed by the Flows component, the reset flow will notify the ApplicationReset event. You can use the onApplicationReset callback of the FlowStateListener instance to insert its own logic for application reset, for example to clear the data managed by the client code and un-register the push token.

In Android Studio, on Windows, press Ctrl+N, or, on a Mac, press command+O, and type WizardFlowStateListener to open WizardFlowStateListener.java. On Windows, press Ctrl+F12, or, on a Mac, press command+F12, and type onApplicationReset to move to the onApplicationReset method.

!