SAPcpmsUsagePolicyApplyStep
open class SAPcpmsUsagePolicyApplyStep : OnboardingStep
Class for SAPcpmsUsagePolicy and SAPcpmsSettings onboarding step handling to configure SAPFoundation.UsageBroker Singleton object.
-
Custom key of SAPcpmsSettingsParameters
Declaration
Swift
open var sapCPmsSettingsParameterKey: OnboardingInfoKey
-
Custom parameter of usageStoreDbEncryptionKey
Declaration
Swift
open var usageStoreDbEncryptionKey: OnboardingInfoKey
-
Designated initializer
Declaration
Swift
public init()
-
Onboarding function with
OnboardingContext
support used to initialize UsageBroker for multi-user operations.Declaration
Swift
open func onboard(context: OnboardingContext, completionHandler: @escaping (OnboardingResult) -> Void)
Parameters
context
OnboardingContext
object which contains every information for the OnboardingStepcompletionHandler
called when the process finished. Error filled on failure.
-
Restore function with
OnboardingContext
support support used to initailze UsageBroker fro muti-user operations.Declaration
Swift
open func restore(context: OnboardingContext, completionHandler: @escaping (OnboardingResult) -> Void)
Parameters
context
OnboardingContext
object which contains every information for the OnboardingStepcompletionHandler
called when the process finished. Error filled on failure.
-
resetPasscode function with
OnboardingContext
supportDeclaration
Swift
open func resetPasscode(context: OnboardingContext, completionHandler: @escaping (OnboardingResult) -> Void)
Parameters
context
completionHandler
called when the process finished. Step OnboardingResult filled.
-
This function resets the modifications of
SAPcpmsUsagePolicy
modifications inOnboardingContext
Declaration
Swift
open func reset(context: OnboardingContext, completionHandler: @escaping () -> Void)
Parameters
context
OnboardingContext
object which contains every information for the OnboardingStepcompletionHandler
called when the process finished.
-
onboard(onboardingID:encryptionKey:sapURLSession:sapcpmsSettingsParameters:sapcpmsUsagePolicy:completionHandler:)
Onboarding function without context for SAPcpmsUsagePolicy.
Declaration
Swift
open func onboard(onboardingID: UUID, encryptionKey: String, sapURLSession: SAPURLSession, sapcpmsSettingsParameters: SAPcpmsSettingsParameters, sapcpmsUsagePolicy: SAPcpmsUsagePolicy?, completionHandler: @escaping (Error?) -> Void)
Parameters
onboardingID
The unique identifier of an onboarding flow.
encryptionKey
value used to access usage store associated with onboardingID
sapURLSession
SAPURLSession
that handles the connection to download destinationsapcpmsSettingsParameters
SAPcpms settings metadata to be able to concatenate the SAPcpms URL
sapcpmsUsagePolicy
conditional policy describing how to configure UsageBroker
completionHandler
called when the process finished. Error filled on failure.
-
restore(onboardingID:encryptionKey:sapURLSession:sapcpmsSettingsParameters:sapcpmsUsagePolicy:completionHandler:)
Restore function without context for SAPcpmsUsagePolicy.
Declaration
Swift
open func restore(onboardingID: UUID, encryptionKey: String, sapURLSession: SAPURLSession, sapcpmsSettingsParameters: SAPcpmsSettingsParameters, sapcpmsUsagePolicy: SAPcpmsUsagePolicy?, completionHandler: @escaping (Error?) -> Void)
Parameters
onboardingID
The unique identifier of an onboarding flow.
encryptionKey
value used to access usage store associated with onboardingID
sapURLSession
SAPURLSession
that handles the connection to download destinationsapcpmsSettingsParameters
SAPcpms settings metadata to be able to concatenate the SAPcpms URL
sapcpmsUsagePolicy
conditional policy describing how to configure UsageBroker
completionHandler
called when the process finished. Error filled on failure.
-
This function resets the modifications of the SAPcpmsUsagePolicy.
Declaration
Swift
open func reset(completionHandler: @escaping () -> Void)
Parameters
completionHandler
called when the process finished.