Skip to main content

Introduction


The Osano ConsentSDK for iOS is a native framework that integrates with the Consent Management Platform on the Osano Website. It is necessary to have an account, and a Cookie Consent configuration created and published in order for this SDK to be able to record end-user consents.

How do I use it?

ConsentManager

First, you must create an instance of the ConsentManager object. This object contains the general configuration parameters that will be used throughout the life of the application.

import ConsentSDK
// ...
let consentManager = ConsentManager(
customerId: "my_customer_id",
configId: "my_config_id",
consentingDomain: "my.consenting.domain",
extUsrData: "my_user_data"
)

Note that the configId and customerId parameters are not optional, and must match the values of your configuration on the Osano website.

UI Builder

Now that you have created an instance of the ConsentManager, you can use it to create and show consent messages in your application. There are two types of dialogues available to show in the SDK, and (depending on the geo-location of your end-user) the UI for each will look different. This is due to legal requirements that are in place for the end-user's geo-location. Rest assured, these UI differences are intentional and necessary to maintain legal compliance for the location of your users.

The dialogue UI can be personalized via the following builder parameters:

let consentUiBuilder = ConsentUiBuilder(
storagePolicyHref: nil,
languageCode: nil,
consentManager: consentManager,
hideDisclosures: true
)

// You can also provide custom color overrides for the UI

let consentUiBuilder = ConsentUiBuilder(
linkColor: nil,
toggleButtonOnColor: nil,
toggleOnBackgroundColor: nil,
toggleButtonOffColor: nil,
toggleOffBackgroundColor: nil,
buttonBackgroundColor: nil,
buttonForegroundColor: nil,
dialogBackgroundColor: nil,
dialogForegroundColor: nil,
buttonDenyBackgroundColor: nil,
buttonDenyForegroundColor: nil,
infoDialogBackgroundColor: nil,
infoDialogForegroundColor: nil,
infoDialogOverlayColor: nil,
storagePolicyHref: nil,
languageCode: nil,
consentManager: consentManager,
hideDisclosures: true
)
note

If you do not provide values for the color overrides, or other optional parameters, the SDK will use the values that are set in your configuration on the Osano website.

Display Modes

The UI may de shown in 2 different ways:

Dialog

The Dialog View Controller allows you to show a consent message and the required data storage preferences based on the country the device is in. The SDK takes care of figuring out which consent variant must be shown based on the device's locale. You can choose the presentation type with the PresentationType enum

public enum PresentationType: Int {
case modal
case fullScreen
case bottomSheet
}

To create the dialogue and show it, use the showDialogViewController method:

let type = ConsentUiBuilder.PresentationType.fullScreen
consentUiBuilder.showDialogViewController(presenterViewController: self, type: type) { (categories) in
print(categories)
} deny: {
print("User denied")
}
note

The dialog (depending on the end-user's geo-location) may have an automatic timeout, which will grant consent upon closure. This is normal functionality for specific global regions.

Declined to Consent

If a the completion callback notifies you that the end-user declined to consent, this does not mean they denied consent. It simply means that they did not make a selection.

The Drawer UI will not allow the user to dismiss the modal without making a selection, but the Dialog UI (in some geo-locations) will allow the user to dismiss the modal without making a selection. This is why it is important to check the categories array in the completion callback to determine if the user has actually declined to consent.

Drawer

The Drawer View Controller allows you to display all consent categories using a built-in UI. In this dialogue, the user can choose to enable or disable any of the consent categories. To user the view controller and show it, use the method showDrawerViewController

consentUiBuilder.showDrawerViewController { (categories) in
print(categories)
}

Using Custom UI

If the SDK's built-in UI does not fit your requirements, you can use the ConsentManager's APIs and integrate them to your own app's UI:

To save (locally and remotely) new consent categories use:

let analytics = OsanoCategoryObject.factory(category: .essential) // .analytics, .essential, .marketing, .personalization, .opt_out
consentManager.consent(objectCategories: [analytics])

To get the list of consented categories (local storage):

guard let consentedArray = consentManager.userConsentedCategories() as? [String] else { return }
let consentedString = consentedArray.joined(separator: ", ")
print(consentedString)

To get whether the user has already gone through the consent process:

let userConsented = consentManager.userConsent()