Specific Actions

Here's a list of methods that could be useful if you want to interact further with our SDK (updating some data sets, overriding consent, etc)

Clear consent

Locally removes user consent, but not on the server (this will allow a new display of the CMP on the next call to presentNotice for example)

func clearConsent() 

Set external ids

Allows to define additional Ids that will be taken into account when validating user consent.

func setExternalIds(externalIds: [String: String]) -> Self

Example:

Swift

let externalsIds = ["customPersonalId": "abze43"]
appConsent.setExternalIds(externalIds: externalsIds)

Objective-C

  NSDictionary* infos = @{@"customPersonalId": @"abze43"};
  [self.appConsent setExternalIdsWithExternalIds:infos];

Once save locally, you can call saveExternalIds methods below to transmit the external ids.

Save external ids

This method transmit all our previous externalIds saved to our servers.

callback-based

func saveExternalIds(_ completion: ACTypedResultVoidHandler?)

Example:

Swift

appConsent.saveExternalIds { result in
            switch result {
                case .success:
                print("🔥 Save External Ids Successful")
            case .failure:
                print("🔥 Save External Ids Failure")
            }
        }

Objective-C

  NSDictionary* data = [self.appConsent getExternalIds];

modern concurrency

func saveExternalIds() async -> Result<Bool, NoticeError>

Swift

let result = await appConsent.saveExternalIds()

Objective-C

Not available

Get external ids

Retrieves your previously registered external ids

func getExternalIds() -> Dictionary<String, String>

Swift

let externalIds: [String: String] = appConsent.getExternalIds()

Objective-C

  NSDictionary* data = [self.appConsent getExternalIds];

Overwrite Consent Status

This method allows you to overwrite a given user consent based on your internal business rules.

It requires to build a ConsentOverride object that contains multiples optional properties that allows you to override consent for specific elements (purposes, specialPurposes, vendors, etc). Each property require is a list of ConsentStatus that is constructed with on your element Id, the consent status and the legintStatus (optional, default value: false) Callback-based

Swift

  let purposes = [
  ConsentStatus(id: 1, status: true),
  ConsentStatus(id: 3, status: true, legintStatus: false)
  ]
  
  let specialPurposes = [
        ConsentStatus(id: 19, status: true),
        ConsentStatus(id: 23, status: true, legintStatus: false)]
        
 let consent = ConsentOverride(
 purposes: purposes, 
 specialPurposes: specialPurposes
  )
        
 appConsent.overwriteConsent(consent: consent) { success in 
  // Success tells you whether the override consent has been applied or not
}

Objective-C

Not available

Modern concurrency

Swift

  let purposes = [
  ConsentStatus(id: 1, status: true),
  ConsentStatus(id: 3, status: true, legintStatus: false)
  ]
  
  let specialPurposes = [
        ConsentStatus(id: 19, status: true),
        ConsentStatus(id: 23, status: true, legintStatus: false)]
        
 let consent = ConsentOverride(
 purposes: purposes, 
 specialPurposes: specialPurposes
  )
        
 await appConsent.overwriteConsent(consent: consent)

Objective-C

Not available

Save floating purposes

This method allows to save a consent on a floating purpose.

callback-based

func saveFloatingPurpose(data: [String: Bool], completion: ACTypedResultVoidHandler?)

Example:

Swift

appConsent.saveFloatingPurpose(data: ["customFloatingPurpose": true]) { result in}

Objective-C

Not available

modern concurrency

func saveFloatingPurpose(data: [String: Bool]) async -> Result<Bool, NoticeError>

Swift

let result = await appConsent.saveFloatingPurpose(data: ["customFloatingPurpose": true])

Objective-C

Not available

Force Accept All

This method allows forcing acceptance of all purposes

callback-based

func setForceAcceptAll(completion: ACCompletionHandler?)

Example:

Swift

appConsent.setForceAcceptAll { success in }

Objective-C

[self.appConsent setForceAcceptAllWithCompletion:^(BOOL success) {}];

modern concurrency

func setForceAcceptAll() async -> Bool

Swift

 let success = await appConsent.setForceAcceptAll()

Objective-C

Not available

Force Deny All

This method allows forcing deny of all purposes

callback-based

func setForceDenyAll(completion: ACCompletionHandler?)

Example:

Swift

appConsent.setForceDenyAll { success in }

Objective-C

[self.appConsent setForceDenyAllWithCompletion:^(BOOL success) {}];

modern concurrency

func setForceDenyAll() async -> Bool

Swift

 let success = await appConsent.setForceDenyAll()

Confirm whether you need to request consent again for a specific floating purpose id

callback-based

func isFloatingNeedUpdate(id: String, completion: ACTypedResultVoidHandler?) 

Example:

Swift

 appConsent.isFloatingNeedUpdate(id: "customFloatingPurpose") { result in }

Objective-C

Not available

modern concurrency

func isFloatingNeedUpdate(id: String) async -> Bool

Swift

let result = await appConsent.isFloatingNeedUpdate(id: "customFloatingPurpose")

Objective-C

Not available