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

Package-level declarations

Types

ActivationDiscoveryExtension

open class ActivationDiscoveryExtension

ActivationOption

enum ActivationOption : Enum<ActivationOption>

The activation method

ActivationSelectionExtension

open class ActivationSelectionExtension

AuthScreenMessageType

enum AuthScreenMessageType : Enum<AuthScreenMessageType>

Represents the message types of the authentication screen messages.

BasicAuthenticationExtension

open class BasicAuthenticationExtension

Represents the customization of basic authentication screen.

BiometricScreenExtension

open class BiometricScreenExtension

Represents the customization of the biometric enablement or unlock screens. These 2 screens basically have no interactive UI elements like buttons, checkboxes, etc, but only a screen with information on what the screen is about and how the user is going to interact with the popup view on top of it, which is provided by the SDK to integrate with the Android biometric features.

BrowserFallbackPolicy

enum BrowserFallbackPolicy : Enum<BrowserFallbackPolicy>

Represents the fallback policy for the browser used during the authentication process when the using CCT.

CustomStepInsertionPoint

sealed class CustomStepInsertionPoint

Represents the custom onboarding step insertion points.

CustomStyles

data class CustomStyles(val lightThemeAttributes: BaseAttributes = BaseAttributes( baseColors = fioriHorizonMorningColors.duplicate().apply { resetMaterialColorScheme() statusBarColor = SapFioriColorS1 }), val darkThemeAttributes: BaseAttributes = BaseAttributes( baseColors = fioriHorizonEveningColors.duplicate().apply { resetMaterialColorScheme() statusBarColor = SapFioriColorS1 }), val applyStatusBarColor: Boolean = true)

Represents the custom styles.

FlowActionHandler

open class FlowActionHandler

The overall flow action handler, where client code can provide specific logic to, say, validate the pass code, the barcode which is used to get the application configuration, or add additional properties to PasscodePolicy

FlowOptions

data class FlowOptions(val fullScreen: Boolean = false, val activationOption: ActivationOption = ActivationOption.QR_ONLY, val useDefaultEulaScreen: Boolean = true, val oAuthOption: OAuthOption = OAuthOption(), val screenSettings: CustomScreenSettings = CustomScreenSettings(), val customStyles: CustomStyles = CustomStyles(), val resetOption: ResetOption = ResetOption(), val qrScanOption: QRScanOption = QRScanOption(), val restoreOption: RestoreOption = RestoreOption())

Represents the options to run the predefined flows.

FlowScreenExtension

open class FlowScreenExtension

FlowStateListener

open class FlowStateListener

Represents the flow state listener, with which client code can insert logic at certain points during the flow process, for example, after AppConfig is ready, the client app wants to initialize some services which need the information of AppConfig.

OAuthOption

data class OAuthOption(val webOption: OAuth2WebOption = OAuth2WebOption.WEB_VIEW, val enablePKCE: Boolean = true, val browserWhitelist: BrowserWhitelist = BrowserWhitelist.getDefault(), val preferredBrowser: BrowserDetails? = null, val browserFallbackPolicy: BrowserFallbackPolicy = BrowserFallbackPolicy.USE_WEB_VIEW, val showAuthDialog: Boolean = true)

Represents the flow option related to OAuth authentication. Here is an example:

QRCodeSecureOption

enum QRCodeSecureOption : Enum<QRCodeSecureOption>

Represents the QR code type, either signed, not signed, or detect both automatically.

QRScanOption

data class QRScanOption(val requireQRCodeConfirmScreen: Boolean = true, val qrCodeSecureOption: QRCodeSecureOption = QRCodeSecureOption.UNSPECIFIED, val scannerIntentAction: String = "scan")

Represents the QR code scan related options.

ResetOption

data class ResetOption(val showOnTimeoutSignInScreen: Boolean = false, val showOnRestoreSignInScreen: Boolean = true)

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.

SetPasscodeExtension

open class SetPasscodeExtension

Represents the customization of the passcode creation screen.

SignInScreenUserInfo

data class SignInScreenUserInfo(val title: String, val avatarText: String, val subTitle: String = "")

Represents the user information shown on the sign in screen.

SignInWithPasscodeExtension

open class SignInWithPasscodeExtension

Represents the sign in screen customization.

VerifyPasscodeExtension

open class VerifyPasscodeExtension

Represents the customization of the passcode verification screen.