WelcomeScreenStep

open class WelcomeScreenStep : OnboardingStep, FUIWelcomeControllerDelegate, FUIOnboardingScanViewControllerDelegate

extension WelcomeScreenStep: ConfigurationLoaderDelegate

extension WelcomeScreenStep: ConfigurationPersisting

Class for Welcome Screen onboarding step handling UI elements of the Welcome Screen are localizable through the step’s welcomeScreenCustomizationHandler which will be called during the WelcomeStep onboarding process to configure the screen.

## Customization


 // The customized WelcomeStep can be created like the following code snippet
 func configuredWelcomeScreenStep() -> WelcomeScreenStep {
    let discoveryConfigurationTransformer = DiscoveryServiceConfigurationTransformer(applicationID: "sample.application.id", authenticationPath: "sample.application.id")
    let welcomeScreen = WelcomeScreenStep(transformer: discoveryConfigurationTransformer, providers: [FileConfigurationProvider()])

   let welcomeScreenBundle = Bundle(for: WelcomeScreenStep.self)
   let localizedHeadlineLabelText = NSLocalizedString("WelcomeScreenHeadlineLabelKey", tableName: "ExampleTableName", bundle: welcomeScreenBundle, value: "Example Headline Text", comment: "")
   let localizedDetailLabelText = NSLocalizedString("WelcomeScreenDetailLabelKey", tableName: "ExampleTableName", bundle: welcomeScreenBundle, value: "Example Headline Text", comment: "")
   let localizedPrimaryActionButtonText = NSLocalizedString("WelcomeScreenPrimaryActionButtonTextKey", tableName: "ExampleTableName", bundle: welcomeScreenBundle, value: "Example Headline Text", comment: "")
   let localizedFootnoteActionButtonTitleText = NSLocalizedString("WelcomeScreenFootnoteActionButtonTextKey", tableName: "ExampleTableName", bundle: welcomeScreenBundle, value: "Example Headline Text", comment: "")
   let localizedFootnoteLabelText = NSLocalizedString("WelcomeScreenFootnoteLabelTextKey", tableName: "ExampleTableName", bundle: welcomeScreenBundle, value: "Example Headline Text", comment: "")

   welcomeScreen.welcomeScreenCustomizationHandler = { welcomeScreen in
       welcomeScreen.headlineLabel.text = localizedHeadlineLabelText
       welcomeScreen.detailLabel.text = localizedDetailLabelText
       welcomeScreen.primaryActionButton.titleLabel?.text = localizedPrimaryActionButtonText
       welcomeScreen.footnoteActionButton.setTitle(localizedFootnoteActionButtonTitleText, for: .normal)
       welcomeScreen.footnoteLabel.text = localizedFootnoteLabelText
   }

   return welcomeScreen
 }

scanConfirmView
provide custom scan confirmation view, defaults to FUIOnboardingScanConfirmView
Declaration
Swift

public var scanConfirmView: UIView?
welcomeScreenCustomizationHandler
Customization of welcome screen UI components.
Declaration
Swift

public var welcomeScreenCustomizationHandler: ((WelcomeStepUI) -> Void)?
activationScreenCustomizationHandler
Customization of activation screen UI components.
Declaration
Swift

public var activationScreenCustomizationHandler: ((ActivationStepUI) -> Void)?
runRestoreIfStoreExists
Runs the restore method during onboarding if the store, and the configuration in it exists. By default this value is false.
Declaration
Swift

public var runRestoreIfStoreExists: Bool
scanConfirmViewCustomizationHandler
Customization of FUIOnboardingScanConfirmView UI components.
Declaration
Swift

public var scanConfirmViewCustomizationHandler: ((ScanConfirmViewUI, [AnyHashable : Any?]) -> Void)?
useCameraOnlyInScanView
Option to enable/disable photo library in FUIOnboardingScanViewController. The default value is false.
Declaration
Swift

public var useCameraOnlyInScanView: Bool
isDigitallySignedQRCodeEnabled
Option to enable/disable scanned QR code signature verification. The default value is false.
Declaration
Swift

public var isDigitallySignedQRCodeEnabled: Bool


                      
                      
                      init(transformer:providers:)

WelcomeScreen OnboardingStep initializer function

Declaration

Swift

public required init(transformer: ConfigurationTransforming = DiscoveryServiceConfigurationTransformer(), providers: [ConfigurationProviding]? = nil)

Parameters

`transformer`	ConfigurationTransforming object which transforms the given configurations
`providers`	ConfigurationProviders to load configurations from

Onboarding implementation


                      
                      
                      onboard(presentationDelegate:credentialStore:completionHandler:)

Onboard function for WelcomeScreenStep

Declaration

Swift

open func onboard(presentationDelegate: FlowPresentationDelegate, credentialStore: CodableStoring, completionHandler: @escaping ([OnboardingInfoKey : Any]?, Error?) -> Void)

Parameters

`presentationDelegate`	delegate to present the `WelcomeScreen`
`credentialStore`	store to save the credentials in
`completionHandler`	called when the process is finished, returns with a WelcomeScreenOnboardingStepResult


                      
                      
                      restore(credentialStore:completionHandler:)

Restore function for WelcomeScreenStep

Declaration

Swift

public func restore(credentialStore: CodableStoring, completionHandler: @escaping ([OnboardingInfoKey : Any]?, Error?) -> Void)

Parameters

`credentialStore`	store to save the credentials in
`completionHandler`	called when the process is finished, returns with a WelcomeScreenOnboardingStepResult


                      
                      
                      reset(completionHandler:)

This function resets the modifications of WelcomeScreenStep

Declaration

Swift

open func reset(completionHandler: @escaping () -> Void)

Parameters


                                  completionHandler

called when the process finished.

Context Support


                      
                      
                      onboard(context:completionHandler:)

Onboard function for WelcomeScreenStep with context support

Declaration

Swift

open func onboard(context: OnboardingContext, completionHandler: @escaping (OnboardingResult) -> Void)

Parameters

`context`	`OnboardingContext` object which contains every information for the OnboardingStep
`completionHandler`	called when the process finished, returns OnboardingResult


                      
                      
                      restore(context:completionHandler:)

Restore function for WelcomeScreenStep with context support

Declaration

Swift

public func restore(context: OnboardingContext, completionHandler: @escaping (OnboardingResult) -> Void)

Parameters

`context`	`OnboardingContext` object which contains every information for the OnboardingStep
`completionHandler`	called when the process finished, returns OnboardingResult


                      
                      
                      background(context:completionHandler:)

background function with OnboardingContext support

Declaration

Swift

public func background(context: OnboardingContext, completionHandler: @escaping (OnboardingResult) -> Void)

Parameters

`context`	`OnboardingContext`
`completionHandler`	called when the process finished. Step OnboardingResult filled.


                      
                      
                      resetPasscode(context:completionHandler:)

resetPasscode function with OnboardingContext support

Declaration

Swift

open func resetPasscode(context: OnboardingContext, completionHandler: @escaping (OnboardingResult) -> Void)

Parameters

`context`	`OnboardingContext`
`completionHandler`	called when the process finished. Step OnboardingResult filled.


                      
                      
                      reset(context:completionHandler:)

This function resets the modifications of WelcomeScreenStep in OnboardingContext

Declaration

Swift

open func reset(context: OnboardingContext, completionHandler: @escaping () -> Void)

Parameters

`context`	`OnboardingContext` object which contains every information for the OnboardingStep
`completionHandler`	called when the process finished.

FUIWelcomeControllerDelegate implementation


                      
                      
                      shouldContinueUserOnboarding(_:)

FUIWelcomeControllerDelegate shouldContinueUserOnboarding function implementation

Declaration

Swift

open func shouldContinueUserOnboarding(_ welcomeController: SAPFiori.FUIWelcomeController)

Parameters


                                  welcomeController

FUIWelcomeController instance


                      
                      
                      didSelectDemoMode(_:)

FUIWelcomeControllerDelegate didSelectDemoMode function implementation

Declaration

Swift

open func didSelectDemoMode(_ welcomeController: SAPFiori.FUIWelcomeController)

Parameters


                                  welcomeController

FUIWelcomeController instance


                      
                      
                      welcomeController(_:willNavigateToScannerScreen:)

FUIWelcomeControllerDelegate willNavigateToScannerScreen implementation

Declaration

Swift

public func welcomeController(_ welcomeController: FUIWelcomeController, willNavigateToScannerScreen scanController: FUIOnboardingScanViewController)

Parameters

`welcomeController`	FUIWelcomeController instance
`scanController`	FUIOnboardingScanViewController instance


                      
                      
                      welcomeController(_:shouldTryUserEmail:)

FUIWelcomeControllerDelegate shouldTryUserEmail implementation

Declaration

Swift

public func welcomeController(_ welcomeController: FUIWelcomeController, shouldTryUserEmail userEmail: String)

Parameters

`welcomeController`	FUIWelcomeController instance
`userEmail`	user email entered


                      
                      
                      welcomeController(_:willNavigateToActivationScreen:)

FUIWelcomeControllerDelegate willNavigateToActivationScreen implementation

Declaration

Swift

public func welcomeController(_ welcomeController: FUIWelcomeController, willNavigateToActivationScreen activationScreen: FUIActivationScreen)

Parameters

`welcomeController`	FUIWelcomeController instance
`activationScreen`	FUIActivationScreen instance

FUIOnboardingScanViewControllerDelegate implementation


                      
                      
                      scanViewController(_:shouldValidateScanResult:)

The implementation validates the scanned QR code. If shouldVerifyQRCodeSignature is set to true then QR Code Signature Validation takes place and the method returns with the validation result.

Declaration

Swift

open func scanViewController(_ scanViewController: FUIOnboardingScanViewController, shouldValidateScanResult scanResult: String) -> Bool

Parameters

`scanViewController`	FUIOnboardingScanViewController instance
`scanResult`	the scanned result as a String

Return Value

Bool value which describes if it is valid or not with a true/false value


                      
                      
                      configurationProvider(_:didCompleteWith:)

Delegate method called by ConfigurationLoader.loadConfiguration(userInputs:) when configuration data is found, or when the queue has been exhausted with no data found.

Declaration

Swift

public func configurationProvider(_ provider: ConfigurationProviding?, didCompleteWith result: Bool)

Parameters

`provider`	The configuration provider in the loader’s queue that obtained configuration data, or the last item in the queue if no data was found. Optional to support case where an empty queue was submitted.
`result`	The result of the returned provider’s attempt to retrieve configuration data (see `ConfigurationProviding.provideConfiguration(input:)`). `true` if data was found; otherwise, `false`.


                      
                      
                      configurationProvider(_:requestedInput:completionHandler:)

2.  Stop processing indicator

Delegate method called by ConfigurationLoader.loadConfiguration(userInputs:) after its queue’s input requirements have been gathered. This method will only be called if input is needed and was not supplied during ConfigurationLoader.loadConfiguration(userInputs:).

Declaration

Swift

public func configurationProvider(_ loader: ConfigurationLoader, requestedInput: [String : [String : Any]], completionHandler: @escaping ([String : [String : Any]]) -> Void)

Parameters

`loader`	The configuration loader instance that requires input.
`requestedInput`	The `Dictionary` of `Dictionary` objects with the outer key corresponding to a configuration provider that needs the input, and the outer value being a `Dictionary` describing the required input(s).
`completionHandler`	Callback mechanism to pass input values back to a configuration loader during queue processing.


                      
                      
                      configurationProvider(_:didEncounter:)

Delegate method called by ConfigurationLoader when an error is encountered during the call to a provider’s ConfigurationProviding.provideConfiguration(input:).

Declaration

Swift

public func configurationProvider(_ provider: ConfigurationProviding, didEncounter error: Error)

Parameters

`provider`	The configuration provider in the loader’s queue that encountered the error.
`error`	The `Error` encountered by the configuration provider.


                      
                      
                      persistConfiguration(_:)

Save data using an alternate method. Data supplied in configuration by a calling ConfigurationLoader object will not be retained by that ConfigurationLoader. If reading the data at a later time is required, it is recommended you also implement a mechanism to read data written by this method.

Declaration

Swift

public func persistConfiguration(_ configuration: [AnyHashable : Any])

Parameters


                                  configuration

Data to be saved

resetPersistedConfiguration()
Requests that this class remove any saved data. For example, if your persistConfiguration(_:) writes the data to some key in UserDefaults, delete that key when this method is called. Called by ConfigurationLoader.resetStoredData().
Declaration
Swift

public func resetPersistedConfiguration()