OnboardingControlling

public protocol OnboardingControlling

Protocol for onboarding controller implementations, used by OnboardingSessionManager

  • Should open a flow. It can be a new flow using onboard or an existing flow which is restored. Implementers have to decide

    Declaration

    Swift

    func openFlow(_ completionHandler: @escaping (OnboardingFlow?, Error?) -> Void)

    Parameters

    completionHandler

    called asynchronously when finished. OnboardingFlow provided on success, the Error parameter otherwise

  • Implementer should remove a persisted onboarding flow so it cannot be restored anymore

    Declaration

    Swift

    func resetFlow(for onboardingID: UUID, completionHandler: @escaping (Error?) -> Void)

    Parameters

    onboardingID

    the ID identifying the persisted flow
    completionHandler

    closure called on completion. Error parameter is nil on success or contains the error otherwise