OnboardingSession

open class OnboardingSession

Stores information about an onboarding session Application developer can subclass OnboardingSession to add other app related meaningful properties or to set properties properly. For example when the SAPcpmsSettingsParameters is not stored using the default key in OnboardingContext then subclasses have to implement the code to provide the SAPcpmsSettingsParameters based on the used key

open class YourSession: OnboardingSession {
    var appURL: URL!
    var otherIntProperty: Int = 0
    var appDict = [String: Any]()

    required public init(flow: OnboardingFlow) {
       super.init(flow: flow)

        // When SAPcpmsSettingsParameters is under another key
        self.settingsParameters = flow.context.info[.yourSettingsParameters] as? SAPcpmsSettingsParameters

        self.appURL = URL(string:"")
        self.otherIntProperty = 12
        self.appDict = ["a":"b"]
    }
}

When a custom OnboardingInfoKey needs to be used to store a custom value, then the corresponding OnboardingSession subclass may be implemented as follows:

public extension OnboardingInfoKey {
    static let yourCustomOnboardingInfoKey = OnboardingInfoKey("yourCustomOnboardingInfoKey")
}

class CustomOnboardingStep: OnboardingStep{
     func onboard(context: OnboardingContext, completionHandler: @escaping (OnboardingResult) -> Void) {
         var newContext = context

         // set value under newly added key inside Info dictionary
         newContext.info[.yourCustomOnboardingInfoKey] = "AnyStringValue"

         completionHandler(.success(newContext))
     }

     func restore(context: OnboardingContext, completionHandler: @escaping (OnboardingResult) -> Void) {
         var newContext = context

         // set value under newly added key inside Info Dictionary
         newContext.info[.yourCustomOnboardingInfoKey] = "AnyStringValue"

         completionHandler(.success(newContext))
     }

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

}

open class YourSession: OnboardingSession {

    var yourCustomProperty: Any = ""

    required public init(flow: OnboardingFlow) {
        super.init(flow: flow)

        // set value of custom property here
        yourCustomProperty = flow.context.info[.yourCustomOnboardingInfoKey]
    }
}

//Use the code below to access it
OnboardingSessionManager.shared.onboardingSession?.yourCustomProperty