SAPcpmsDestinationsDownloadStep

open class SAPcpmsDestinationsDownloadStep : OnboardingStep

Class for SAPcpmsDestinations download onboarding step handling

Customization

During the onboarding flow, if there is a splash screen which shows a text, that text can be changed/localized.


// The localized SAPcpmsDestinationsDownloadStep can be created like the following code snippet
func customDestinationsDownloadStep() -> OnboardingStep {
   let step = SAPcpmsDestinationsDownloadStep()

   let sapcpmsDestinationDownloadBundle = Bundle(for: SAPcpmsDestinationsDownloadStep.self)
   step.infoScreenText = NSLocalizedString("SAPcpmsDestinationsDownloadInfoScreenTextKey", tableName: "ExampleTableName", bundle: sapcpmsDestinationDownloadBundle, value: "Example Info Screen Text", comment: "")

   return step
}

settingsInfoKey
The OnboardingInfoKey associated with an instance of SAPcpmsSettingsParameters in the OnboardingContext info.
Declaration
Swift

public var settingsInfoKey: OnboardingInfoKey
infoScreenText
Property to set the title of info screen
Declaration
Swift

public var infoScreenText: String


                      
                      
                      init(loadRemoteDestinations:)

Initializer for SAPcpmsDestinationsDownloadStep. Use this initializer to configure whether remote destinations should be loaded in addition to the default destinations.

Declaration

Swift

public init(loadRemoteDestinations: Bool? = nil)

Parameters


                                  loadRemoteDestinations

A Boolean value indicating whether the step should also download configured remote destinations from mobile services.

If true, after successfully completing this step in onboarding or restore flow, the remote destinations can be accessed from the remoteDestinations parameter of SAPcpmsSettingsParameters.

Context Support


                      
                      
                      onboard(context:completionHandler:)

Onboarding function with OnboardingContext support; Downloads the Destinations from mobile services and updates the stored ‘SAPcpmsSettingsParameters’ with them in the ‘context’.

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. Error filled on failure.


                      
                      
                      restore(context:completionHandler:)

Restore function with OnboardingContext support

Declaration

Swift

open 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. Error filled on failure.


                      
                      
                      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 SAPcpmsDownloadStep modifications 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.

Manual Support


                      
                      
                      onboard(sapURLSession:settingsParameters:completionHandler:)

Onboarding function without context for SAPcpmsDestinations download.

Declaration

Swift

open func onboard(sapURLSession: SAPURLSession, settingsParameters: SAPcpmsSettingsParameters, completionHandler: @escaping ([OnboardingInfoKey : Any]?, Error?) -> Void)

Parameters

`sapURLSession`	`SAPURLSession` that handles the connection to download destination
`settingsParameters`	SAPcpms settings metadata to be able to concatenate the SAPcpms URL
`completionHandler`	called when the process finished. Error filled on failure.


                      
                      
                      restore(sapURLSession:settingsParameters:completionHandler:)

Restore function without context for SAPcpmsDestinations download.

Declaration

Swift

open func restore(sapURLSession: SAPURLSession, settingsParameters: SAPcpmsSettingsParameters, completionHandler: @escaping ([OnboardingInfoKey : Any]?, Error?) -> Void)

Parameters

`sapURLSession`	`SAPURLSession` that handles the connection to download destination
`settingsParameters`	SAPcpms settings metadata to be able to concatenate the SAPcpms URL
`completionHandler`	called when the process finished. Error filled on failure.


                      
                      
                      reset(completionHandler:)

This function resets the modifications of the SAPcpmsDestinationsDownloadStep in the SAPURLSession.

Declaration

Swift

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

Parameters


                                  completionHandler

called when the process finished.