OnboardingControllerDelegate

public protocol OnboardingControllerDelegate : AnyObject

Delegate methods called to track the status of an onboarding flow. Implementers can also modify the flow


                      
                      
                      onboardingController(_:willStart:completionHandler:)

Default implementation

Delegate method called when an OnboardingFlow will start

Default Implementation

Delegate method that indicates when the flow will start

Declaration

Swift

func onboardingController(_: OnboardingControlling, willStart: OnboardingFlow, completionHandler: @escaping (OnboardingFlow?, Error?) -> Void)

Parameters

`_`	`OnboardingControlling` instance
`willStart`	the flow that will start
`completionHandler`	closure called on completion


                      
                      
                      onboardingController(_:didComplete:completionHandler:)

Default implementation

Delegate method called when an OnboardingFlow has completed

Default Implementation

Delegate method that indicates when the flow has completed

Declaration

Swift

func onboardingController(_: OnboardingControlling, didComplete: OnboardingFlow, completionHandler: @escaping (OnboardingFlow?, Error?) -> Void)

Parameters

`_`	`OnboardingControlling` instance
`didComplete`	the flow that completed
`completionHandler`	closure called on completion


                      
                      
                      onboardingController(_:didFail:with:completionHandler:)

Default implementation

Delegate method called when an OnboardingFlow has failed

Default Implementation

Delegate method that indicates if the flow has completed with error

Declaration

Swift

func onboardingController(_: OnboardingControlling, didFail: OnboardingFlow, with: Error, completionHandler: @escaping (OnboardingErrorDisposition) -> Void)

Parameters

`_`	`OnboardingControlling` instance
`didFail`	the flow that failed
`with`	an error object that indicates the reason of failure
`completionHandler`	closure called on completion