Info
Innehåll

[iOS] 3. API-dokumentation

initialisera


Initialiseringsfunktionen initierar samtyckesskiktet och kontrollerar automatiskt om användaren behöver ett samtycke eller inte. Denna funktion kommer så småningom att öppna samtyckeslagret och kommer att interagera med Apple Tracking Transparency API för att be användaren om samtycke

Retur

CMPConsentTool

Exempelvis
let cmpConfig : CmpConfig = CmpConfig.shared.setup(withId: config.appId, domain: config.domain, appName: config.appName, language: config.language);
cmpConsentTool = CMPConsentTool(cmpConfig: cmpConfig).initialize()

 

med CloseListener


Lägger till en nära lyssnare för att få aviseringar när samtyckeslagret stängs.

parametrar
Företag Typ Beskrivning
closeListener fungera Callback som kommer att anropas när samtyckeslagret stängs.
Retur

CMPConsentTool

Exempelvis
func onClose() -> Void {
      NSLog("APP:CLOSED");
      // add custom business logic here
}
cmpConsentTool = CMPConsentTool(cmpConfig: cmpConfig, viewController: self)
            .withCloseListener(onClose)

med OpenListener


Lägger till en öppen lyssnare för att få aviseringar när samtyckeslagret öppnas.

parametrar
Företag Typ Beskrivning
openListener fungera Callback som kommer att anropas när samtyckeslagret öppnas
Retur

CMPConsentTool

Exempelvis
func onOpen() -> Void {
      NSLog("APP:CLOSED");
      // add custom business logic here
}
cmpConsentTool = CMPConsentTool(cmpConfig: cmpConfig, viewController: self)
            .withCloseListener(onOpen)

 

 

med ErrorListener


Lägger till en fellyssnare för att få aviseringar när ett fel inträffade

parametrar
Företag Typ Beskrivning
errorListener fungera Återuppringning för att lägga till åtgärd om ett fel uppstod.
Retur

CMPConsentTool

Exempelvis
func onCMPError(type: CmpErrorType, message: String?) -> Void {
    switch type {
    case .networkError:
        print(message)
        print("error network")
        break
    case .timeoutError:
        print(message)
        print("error timeout")
        break
    case .consentDataReadWriteError:
        print(message)
        print("error consent read/write")
        break
    case .unknownError:
        print(message)
        print("error unknown")
        break
    @unknown default:
        print(message)
        print("error network")
        break
    }
}
cmpConsentTool = CMPConsentTool(cmpConfig: cmpConfig, viewController: self)
            .withErrorListener(onCMPError)

 

med OnCMPNotOpenedListener


Lägger till en Cmp ej öppnad återuppringning för att få meddelande när samtyckeslagret inte öppnas

parametrar
Företag Typ Beskrivning
openListener fungera Återuppringning som kommer att anropas när samtyckeslagret "inte öppnas". Det vanligaste skälet är att användaren redan gett sitt samtycke
Retur

CMPConsentTool

Exempelvis
func onCMPNotOpened() -> Void {
      NSLog("APP:CLOSED");
      // add custom business logic here
}
cmpConsentTool = CMPConsentTool(cmpConfig: cmpConfig, viewController: self)
            .withOnCMPNotOpenedListener(onCMPNotOpened)

 

withOnCmpButtonClickedCallback


Ställer in en återuppringning för att ta emot aviseringar när användaren klickar på en knapp för att stänga samtyckeslagret.

parametrar
Företag Typ Beskrivning
openListener fungera Återuppringning som kommer att anropas med ``CmpButtonEvent`` som indikerar vilken knapp som trycktes ned
Retur

CMPConsentTool

Exempelvis
func onButtonClickedEvent(event: CmpButtonEvent) -> Void {
    switch event {
    case .acceptAll:
        print("user accepted all")
        break
    case .rejectAll:
        print("user accepted all")
        break
    case .save:
        print("user saved custom settings")
        break
    case .close:
        print("user closed consent layer without giving consent")
        break
    @unknown default:
        print("unknown button event")
    }
}
cmpConsentTool = CMPConsentTool(cmpConfig: cmpConfig, viewController: self)
            .withOnCmpButtonClickedCallback(onButtonClickedEvent)

 

med CmpViewControllerConfigurationBlock


Anpassa samtyckeslagret UIViewController

parametrar
Företag Typ Beskrivning

konfigurationsblock

CmpViewControllerConfigurationBlock

Anpassa samtyckesskiktet

UIViewController

Retur

CMPConsentTool

Exempelvis
cmpConsentTool = CMPConsentTool(cmpConfig: cmpConfig)
            .withCmpViewControllerConfigurationBlock({ viewController in
                viewController?.modalPresentationStyle = .formSheet
            })

 

med CmpViewConfigurationBlock


Anpassa samtyckesskiktets UiView

parametrar
Företag Typ Beskrivning

konfigurationsblock

CmpUIViewConfigurationBlock

Anpassa samtyckesskiktet

UiView

Retur

CMPConsentTool

Exempelvis
let cmpLayout = CmpLayout.default()
        cmpLayout?.cornerRadius = 10.0
        cmpLayout?.customLayout = CGRect(x: 0, y: 0, width: 200, height: 300)
cmpConsentTool = CMPConsentTool(cmpConfig: cmpConfig)
                        .withCmpViewConfigurationBlock({ uiView in
                cmpLayout?.apply(to: uiView)
            })

 

medUpdateGoogleConsent


Hämta status för Googles samtycke 

parametrar
Företag Typ Beskrivning

samtyckeMap

[Sträng: Sträng]?

Samtyckesstatus
Retur

CMPConsentTool

Exempelvis
       cmpConsentTool = CMPConsentTool(cmpConfig: cmpConfig)
            .withUpdateGoogleConsent(onCmpUpdateGoogleConsent)
    }

    func onCmpUpdateGoogleConsent(consentMap: [String: String]?) -> Void {
        guard let consentMap = consentMap else { return }

        var firebaseConsentMap: [ConsentType: ConsentStatus] = [:]

        consentMap.forEach { key, value in
            if let consentType = convertToFirebaseConsentType(from: key),
               let consentStatus = convertToFirebaseConsentStatus(from: value) {
                firebaseConsentMap[consentType] = consentStatus
            }
        }

        Analytics.setConsent(firebaseConsentMap)
    }

    func convertToFirebaseConsentType(from key: String) -> ConsentType? {
        switch key {
        case "analytics_storage":
            return .analyticsStorage
        case "ad_storage":
            return .adStorage
        case "ad_user_data":
            return .adUserData
        case "ad_personalization":
            return .adPersonalization
        default:
            return nil
        }
    }

    func convertToFirebaseConsentStatus(from value: String) -> ConsentStatus? {
        switch value {
        case "granted":
            return .granted
        case "denied":
            return .denied
        default:
            return nil
        }
    }

 

checkAndOpenConsentLayer


Kontrollera och öppna samtyckesskiktet

Retur

Inget returvärde

Exempelvis
cmpConsentTool.checkAndOpenConsentLayer()

 

openCmpConsentToolView


Öppnar vyn för CMP-samtyckeslager

Retur

Inget returvärde

Exempelvis
cmpConsentTool.openView()

 

ta


Kolla upp

parametrar
Företag Typ Beskrivning
onCmpLayerOpen fungera Återuppringning när samtyckeslagret måste vara öppet.
är cachad Boolean BOOL flagga när TRUE, kommer begäran att cachelagras och svaret kommer att sparas
Retur

Inget returvärde

Exempelvis
cmpConsentTool?.check(
  	{
		print("Layer wants to open")
    	// self.cmpConsentTool?.openView()
    }, 
    isCached: true, 
    onCmpLayerNotOpen: {
     	print("Layer does not want to open")
    }
)

har samtycke


Kontrollerar om användaren har gett ett samtycke. Samtyckeslagret kan ha möjlighet att bara stänga lagret med. I detta fall har användaren inte gett sitt samtycke.

Retur
Exempelvis
cmpConsentTool.hasConsent()

 

getAllPurposes


Får en kommaseparerad sträng av de inaktiverade "syfte"-ID:n

Retur

Sträng av alla "purpose" ID:n

Exempelvis
cmpConsentTool.getAllPurposes()

 

getAllPurposeList


Hämtar en lista över alla 'purpose' ID:n för den givna Cmp.

Retur

En "lista" som innehåller alla "purpose" ID:n.

Exempelvis
cmpConsentTool.getAllPurposeList()

 

getEnabledPurposes


Får en kommaseparerad sträng av de aktiverade 'purpose' ID:n

Retur

"Sträng" av aktiverade "purpose" ID:n

Exempelvis
cmpConsentTool.getEnabledPurposes()

 

getEnabledPurposeList


Få överenskommen syfteslista

Retur

 

Exempelvis
cmpConsentTool?.getEnabledPurposeList()

 

getDisabledPurposes


Få funktionshindrade syften

Retur

 

Exempelvis
cmpConsentTool?.getDisabledPurposes()

 

getAllVendors


Få alla leverantörer

Retur

 

Exempelvis
cmpConsentTool?.getAllVendors()

 

getAllVendorsList


Hämta listan över alla leverantörer

Retur

 

Exempelvis
cmpConsentTool?.getAllVendorsList()

 

getEnabledVendors


Skaffa aktiverade leverantörer

Retur

 

Exempelvis
cmpConsentTool?.getEnabledVendors()

 

getEnabledVendorList


Få aktiverad leverantörslista

Retur

 

Exempelvis
cmpConsentTool?.getEnabledVendorList()

 

getDisabledVendors


Skaffa funktionshindrade leverantörer

Retur

 

Exempelvis
cmpConsentTool?.getDisabledVendors()

 

aktiveraVendorList


Aktiverar en lista över leverantörer och uppdaterar det givna samtycket

parametrar
Företag Typ Beskrivning
försäljare array Lista över leverantörs-ID som ska aktiveras.
på Finish fungera Återuppringning för hantering av samtycke mottaget händelse. det kommer att anropas när samtycke tas emot och behandlas.
Retur

Inget returvärde

Exempelvis
func onFinish() -> Void {
    NSLog("Notification, that new consent is received");
}
let vendors = ["1","2"]
cmpConsentTool?.enableVendorList(vendors, onFinish: onFinish)

 

inaktiveraVendorList


Inaktiverar en lista över leverantörer och uppdaterar det givna samtycket

parametrar
Företag Typ Beskrivning
försäljare array Lista över leverantörs-ID att inaktivera.
på Finish fungera Återuppringning för hantering av samtycke mottaget händelse. det kommer att anropas när samtycke tas emot och behandlas.
Retur

Inget returvärde

Exempelvis
func onFinish() -> Void {
    NSLog("Notification, that new consent is received");
}
let vendors = ["1","2"]
cmpConsentTool?.disableVendorList(vendors, onFinish: onFinish)

 

enablePurposeList


Aktiverar en lista över syften och uppdaterar det givna samtycket

parametrar
Företag Typ Beskrivning
syfte array Lista över ändamåls-ID att aktivera.
på Finish funktion (valfritt) Återuppringning för hantering av samtycke mottaget händelse. det kommer att anropas när samtycke tas emot och behandlas.
Retur

Inget returvärde

Exempelvis
func onFinish() -> Void {
    NSLog("Notification, that new consent is received");
}
let vendors = ["1","2"]
cmpConsentTool?.enablePurposeList(vendors, onFinish: onFinish)

// or without callback
cmpConsentTool?.enablePurposeList(vendors)

 

disablePurposeList


Inaktiverar en lista med syften och uppdaterar det givna samtycket

parametrar
Företag Typ Beskrivning
syfte array Lista över ändamåls-ID att inaktivera.
på Finish funktion (valfritt) Återuppringning för hantering av samtycke mottaget händelse. det kommer att anropas när samtycke tas emot och behandlas.
Retur

Inget returvärde

Exempelvis
func onFinish() -> Void {
    NSLog("Notification, that new consent is received");
}
let vendors = ["1","2"]
cmpConsentTool?.disablePurposeList(vendors, onFinish: onFinish)

// or without callback
cmpConsentTool?.disablePurposeList(vendors)

 

avvisaAlla


Avvisar samtyckesskiktet och beter sig på samma sätt när användaren "inte accepterade" samtycket

parametrar
Företag Typ Beskrivning
på Finish fungera Återuppringning för hantering av samtycke mottaget händelse. det kommer att anropas när samtycke tas emot och behandlas.
Retur

Inget returvärde

Exempelvis
func onFinish() -> Void {
    NSLog("Notification, that new consent is received");
}
cmpConsentTool.rejectAll(onFinish)

 

acceptera alla


Accepterar samtyckeslagret och beter sig på samma sätt när användaren "godkände" samtycket

parametrar
Företag Typ Beskrivning
på Finish fungera Återuppringning för hantering av samtycke mottaget händelse. det kommer att anropas när samtycke tas emot och behandlas.
Retur

Inget returvärde

Exempelvis
func onFinish() -> Void {
    NSLog("Notification, that new consent is received");
}
cmpConsentTool.acceptAll(onFinish)

 

getUSPrivacyString


Skaffa US Privacy String

Retur

`String` USA:s sekretesssträng, som sattes av consentmanager

Exempelvis
cmpConsentTool.getUSPrivacyString()

 

har säljarens samtycke


Har säljarens samtycke

parametrar
Företag Typ Beskrivning
Leverantörs-ID Sträng Leverantörs-ID
vendorIsV1orV2 BOOl om leverantörs-id är en IAB-leverantör. (utfasad: Flaggan behövs inte längre)
Retur
Exempelvis
cmpConsentTool.hasVendorConsent("vendorID")

 

hasPurposeConsent


Kontrollerar om ändamåls-ID är aktiverat baserat på användarens samtycke.

parametrar
Företag Typ Beskrivning
ändamåls-ID Sträng syfte id
vendorIsV1orV2 BOOl om leverantörs-id är en IAB-leverantör. (utfasad: Flaggan behövs inte längre)
Retur

 

Exempelvis
cmpConsentTool.hasPurposeConsent("purposeID")

 

getGoogleACString


Hämtar Google Add ID (`addtlConsent`)-strängen som ställts in av consent manager.

Retur

Google AC-sträng

Exempelvis
cmpConsentTool.getGoogleACString()

 

getConsentstring


Få den senaste samtyckessträngen

Retur
Exempelvis
getConsentstring()

 

exportCmpString


Exporterar CmpData-strängen

Retur

CmpData String base64-kodad

Exempelvis
CMPConsentTool.exportCmpString()

 

samtyckeBegärt Idag


Kontrollerar om samtyckeslagret begärdes idag

Retur

SANT om CMPConsent Manager Servern begärdes idag, annars FALSK

Exempelvis
cmpConsentTool.consentRequestedToday()

 

är SamtyckeKrävs


Kontrollerar om användaren behöver accepteras

Retur

SANT om användaren behöver ge ett samtycke.

Exempelvis
cmpConsentTool.isConsentRequired()

 

återställa


Återställer all data som ställts in av ``CMPConsentTool``

Retur

Inget returvärde

Exempelvis
CMPConsentTool.reset()

 

Tillbaka till toppen