APIKeyAuthenticationStep

open class APIKeyAuthenticationStep : OnboardingStep

Onboarding step implementation of APIKey Authentication Used in the onboarding/restoring flow, this step is responsible to configure the app’s URLSession to be able to communicate with apikey authentication protected resources. Creates and registers the APIKeyAuthenticationObserver to the SAPURLSession, then sends a validation request.

isAllowingOfflineRestore
Tells the authentication step whether offline restore should be supported. If the property is true, the authentication step gracefully handles network conditions when restoring while offline. By default this property is true.
Declaration
Swift

public var isAllowingOfflineRestore: Bool

Public methods

init()
Designated initializer
Declaration
Swift

public init()


                      
                      
                      init(config:)

Undocumented

Declaration

Swift

public init(config: APIKeyAuthenticationConfig?)


                      
                      
                      onboard(sapURLSession:validationURL:apikeyAuthConfig:completionHandler:)

Onboards to the given URL

Declaration

Swift

open func onboard(sapURLSession: SAPURLSession, validationURL: URL, apikeyAuthConfig: APIKeyAuthenticationConfig, completionHandler: @escaping (Error?) -> Void)

Parameters

`sapURLSession`	`SAPURLSession` that handle the connection to the authenticationURL
`validationURL`	resource URL that is used for auth validation
`apikeyAuthConfig`	`APIKeyAuthenticationConfig`to be used for apikey authentication
`completionHandler`	called when the process finished. Error filled on failure.


                      
                      
                      restore(sapURLSession:validationURL:apikeyAuthConfig:completionHandler:)

Restore the previous state of onboarding

Declaration

Swift

open func restore(sapURLSession: SAPURLSession, validationURL: URL, apikeyAuthConfig: APIKeyAuthenticationConfig, completionHandler: @escaping (Error?) -> Void)

Parameters

`sapURLSession`	`SAPURLSession` that handle the connection to the authenticationURL
`validationURL`	resource URL that is used for auth validation
`apikeyAuthConfig`	`APIKeyAuthenticationConfig`to be used for apikey authentication
`completionHandler`	called when the process finished. Error filled on failure.


                      
                      
                      reset(sapURLSession:completionHandler:)

Resets the modifications of step

Declaration

Swift

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

Parameters

`sapURLSession`	`SAPURLSession` on which the apikey authentication observer has to be removed
`completionHandler`	called when the process finished.


                      
                      
                      createAPIKeyAuthenticationObserver(apiKeyCredentialDiscovery:isAPIKeyAccessOnlySecConfig:)

This method creates the APIKeyAuthenticationObserver instance used on the SAPURLSession in the OnboardingContext. The step user may override this method to supply a custom APIKeyAuthenticationObserver.

Declaration

Swift

open func createAPIKeyAuthenticationObserver(apiKeyCredentialDiscovery: APIKeyCredentialDiscovery, isAPIKeyAccessOnlySecConfig: Bool) -> APIKeyAuthenticationObserver

Parameters

`apiKeyCredentialDiscovery`	The `FioriBasicCredentialsViewControllerPresenter` used by the observer.
`isAPIKeyAccessOnlySecConfig`	The flag that should be set to true for API Key Access Only security configuration, else false.

Return Value

An instance of the BasicAuthenticationObserver.

Context Support


                      
                      
                      onboard(context:completionHandler:)

Onboarding function with OnboardingContext support

Declaration

Swift

open func onboard(context: OnboardingContext, completionHandler: @escaping (OnboardingResult) -> Void)

Parameters

`context`	`OnboardingContext`
`completionHandler`	called when the process finished. Step OnboardingResult filled.


                      
                      
                      restore(context:completionHandler:)

Restore function with OnboardingContext support

Declaration

Swift

open func restore(context: OnboardingContext, completionHandler: @escaping (OnboardingResult) -> Void)

Parameters

`context`	`OnboardingContext`
`completionHandler`	called when the process finished. Step OnboardingResult filled.


                      
                      
                      background(context:completionHandler:)

Background function with OnboardingContext support

Declaration

Swift

open func background(context: OnboardingContext, completionHandler: @escaping (OnboardingResult) -> Void)

Parameters

`context`	`OnboardingContext`
`completionHandler`	called when the process finished. Step OnboardingResult filled.


                      
                      
                      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:)

Reset function with OnboardingContext support

Declaration

Swift

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

Parameters

`context`	`OnboardingContext`
`completionHandler`	called when the process finished.