SAPcpmsClientResourcesDownloadStep

open class SAPcpmsClientResourcesDownloadStep : OnboardingStep

Class for SAPcpmsClientResources 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 SAPcpmsClientResourcesDownloadStep can be created like the following code snippet
func customClientResourcesDownloadStep() -> OnboardingStep {
   let step = SAPcpmsClientResourcesDownloadStep()

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

   return step
}

  • Onboarding function without context for SAPcpmsClientResources download. If you want to download the configured ClientResources from mobile services then use the other onboard() function with OnboardingContext support, or use ‘SAPcpmsClientResources’ component from SAPFoundation framework.

    Declaration

    Swift

    open func onboard(sapURLSession: SAPURLSession, credentialStore: CodableStoring, settingsParameters: SAPcpmsSettingsParameters, completionHandler: @escaping (Error?) -> Void)

    Parameters

    sapURLSession

    SAPURLSession that handle the connection to download settings

    settingsParameters

    SAPcpmsSettingsParameters object

    completionHandler

    called when the process finished. Error filled on failure.

  • Restore function without context for SAPcpmsClientResources download.

    Declaration

    Swift

    open func restore(sapURLSession: SAPURLSession, credentialStore: CodableStoring, settingsParameters: SAPcpmsSettingsParameters, completionHandler: @escaping (Error?) -> Void)

    Parameters

    sapURLSession

    SAPURLSession that handle the connection to download settings

    settingsParameters

    SAPcpmsSettingsParameters object

    completionHandler

    called when the process finished. Error filled on failure.

  • This function resets the modifications of the SAPcpmsClientResourcesDownloadStep in the SAPURLSession.

    Declaration

    Swift

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

    Parameters

    completionHandler

    called when the process finished.