flows-compose/com.sap.cloud.mobile.flows.compose.ext/RestoreOption

RestoreOption

data class RestoreOption(val skipRestoreFlowScreens: Boolean = false, val handleLockAndWipeInRestoreFlow: Boolean = true, val executeForgotPasscodeWhenRetryLimitReached: Boolean = true, val showForgotPasscodeOnSignInScreen: Boolean = true, val immediatePasscodeChange: Boolean = false, val skipWipeInformationDialog: Boolean = false, val enableCrossContextForNonPrimaryUser: Boolean = false, val showUserListFirst: Boolean = false)

Represents the flow options for the restore flows. Please note that since 25.4, 'forgot passcode' is renamed to 'reset passcode', but the property names remain 'forgot passcode' for backward compatibility.

Constructors

RestoreOption

constructor(skipRestoreFlowScreens: Boolean = false, handleLockAndWipeInRestoreFlow: Boolean = true, executeForgotPasscodeWhenRetryLimitReached: Boolean = true, showForgotPasscodeOnSignInScreen: Boolean = true, immediatePasscodeChange: Boolean = false, skipWipeInformationDialog: Boolean = false, enableCrossContextForNonPrimaryUser: Boolean = false, showUserListFirst: Boolean = false)

Properties

enableCrossContextForNonPrimaryUser

val enableCrossContextForNonPrimaryUser: Boolean

Whether to enable the non-primary user onboards via scanning the user cross context SSO QR code. This is for the create account and reset passcode flows started from the sign in screen. If the create account flow is started from the client code, SDK will also check this option to enable the cross context SSO QR code scan feature.

executeForgotPasscodeWhenRetryLimitReached

val executeForgotPasscodeWhenRetryLimitReached: Boolean

In the restore or timeout flow, when the retry limit reached, a dialog will pop up. When clicking the 'OK' button of the dialog, if this property is 'true', the reset passcode flow will kick in, otherwise, just dismiss the dialog.

handleLockAndWipeInRestoreFlow

val handleLockAndWipeInRestoreFlow: Boolean

The option to specify whether to let the restore flow handle the lock and wipe policy or not. When it's set to 'true', the restore flow will do auto unlock by re-authenticate the user when the device should be locked, or delete the current user when the current user data should be wiped. It can be set to 'false' when the client app wants to use 'LockAndWipeService' to manage the last connection time and the policy of each user but do the unlock or delete user data by itself.

immediatePasscodeChange

val immediatePasscodeChange: Boolean

Whether or not to start the change passcode flow immediately when the current passcode does not comply with the new passcode policy during the restore flow. By default, this is 'false', a notification will be sent out in such case.

showForgotPasscodeOnSignInScreen

val showForgotPasscodeOnSignInScreen: Boolean

Whether to show the reset passcode button on the sign in screen

showUserListFirst

val showUserListFirst: Boolean

Whether to show the user list screen first for a multiple user app or not. This is only for the restore flow, not for the 'timeout' flow.

skipRestoreFlowScreens

val skipRestoreFlowScreens: Boolean

Whether to skip the restore flow screens if passcode policy is not enabled. This is usually used for demo apps with passcode policy disabled at the server side.

skipWipeInformationDialog

val skipWipeInformationDialog: Boolean

Whether to skip the information dialog when wiping is needed during the restore flow.