UserConsentStep

open class UserConsentStep : OnboardingStep, FUIUserConsentViewControllerDelegate

Manages the User Consent Handling. The version for each user consent form will be stored in the credentialStore of the OnboardingContext which is used to decide if a newer version of the form should be presented in the next run. If a new version for the form is present, the form will be displayed in the next run to request user confirmation.

Usage

// Content for the single page form
let spTitle = "Data Privacy"
let spText = "Detailed text about how data privacy pertains to this app and why it is important for the user to enable this functionality"
let spActionTitle = "Learn more about Data Privacy"

var spPageContent = UserConsentPageContent()
spPageContent.title = spTitle
spPageContent.body = spText
spPageContent.actionTitle = spActionTitle
spPageContent.actionUrl = "http://www.sap.com"
let spFormContent = UserConsentFormContent( version: "one",isRequired: true,pages: [spPageContent])

//Content for the multi Page form
let mpTitle1 = "Data Privacy"
let mpText1 = "Detailed text about how data privacy pertains to this app and why it is important for the user to enable this functionality"
let mpActionTitle1 = "Learn more about Data Privacy"
var mpPageContent1 = UserConsentPageContent()
mpPageContent1.title = mpTitle1
mpPageContent1.body = mpText1
mpPageContent1.actionTitle =  mpActionTitle1
mpPageContent1.actionHandler = { controller in
   let alert = UIAlertController(title: "Data Privacy", message: "Alert for Data Privacy Page", preferredStyle: UIAlertControllerStyle.alert)
   alert.addAction(UIAlertAction(title: "OK", style: UIAlertActionStyle.default, handler: nil))
   controller.present(alert, animated: true, completion: nil)
}

let mpTitle2 = "Security"
let mpText2 = "Detailed text about how data privacy pertains to this app and why it is important for the user to enable this functionality"
let mpActionTitle2 = "Learn more about Data Privacy"
var mpPageContent2 = UserConsentPageContent()
mpPageContent2.title = mpTitle2
mpPageContent2.body = mpText2
mpPageContent2.actionTitle =  mpActionTitle2
// When both url and action handler are set, the action handler takes precedence.
mpPageContent2.actionUrl = "http://www.sap.com"
mpPageContent2.actionHandler = { controller in
   let alert = UIAlertController(title: "Data Privacy", message: "Alert for Data Privacy Page", preferredStyle: UIAlertControllerStyle.alert)
  alert.addAction(UIAlertAction(title: "OK", style: UIAlertActionStyle.default, handler: nil))
  controller.present(alert, animated: true, completion: nil)
}

let mpTitle3 = "Consent"
let mpText3 = "Detailed text about how data privacy pertains to this app and why it is important for the user to enable this functionality"

let mpActionTitle3 = "Learn more about Data Privacy"
var mpPageContent3 = UserConsentPageContent()
mpPageContent3.title = mpTitle3

// It is possible to provide attributed text to enable adding developer defined attributes to the text other than the default.
// Eg. change the font type to "Georgia" and size to "17.0" for the body. This can be done for the title and actionTitle as well , using the
// titleAttributedText and actionTitleAttributedText respectively. When both body and bodyAttributedText are provided , the
// attributedtext version takes precedence.
//        let mpAttributes3 = [NSAttributedStringKey.font: UIFont(name: "Georgia", size: 17.0)!]
//        let mpBody3 = NSAttributedString(string: mpText3, attributes: mpAttributes3)
//        mpPageContent3.bodyAttributedText = mpBody3

mpPageContent3.body = mpText3
mpPageContent3.actionTitle =  mpActionTitle3

let mpFormContent = UserConsentFormContent( version: "one",isRequired: true,pages: [mpPageContent1, mpPageContent2, mpPageContent3])
let userConsentStep  =  UserConsentStep(userConsentFormsContent:[spFormContent, mpFormContent])