[iOS] 3. API-documentatie
API
initialiseren
De functie Initialize initialiseert de toestemmingslaag en controleert automatisch of de gebruiker toestemming nodig heeft of niet. Deze functie opent uiteindelijk de toestemmingslaag en communiceert met de Apple Tracking Transparency API om de gebruiker om toestemming te vragen
Retourneren
CMPConsentTool
Voorbeeld
cmpConsentTool = CMPConsentTool(cmpConfig: cmpConfig, viewController: self)
.initialize()
metCloseListener
Voegt een goede luisteraar toe om meldingen te ontvangen wanneer de toestemmingslaag wordt gesloten.
parameters
| Naam | Type | Omschrijving |
| closeListener | functie | Callback die wordt aangeroepen wanneer de toestemmingslaag wordt gesloten. |
Retourneren
CMPConsentTool
Voorbeeld
func onClose() -> Void {
NSLog("APP:CLOSED");
// add custom business logic here
}
cmpConsentTool = CMPConsentTool(cmpConfig: cmpConfig, viewController: self)
.withCloseListener(onClose)met OpenListener
Voegt een open luisteraar toe om meldingen te ontvangen wanneer de toestemmingslaag wordt geopend.
parameters
| Naam | Type | Omschrijving |
| openListener | functie | Callback die wordt aangeroepen wanneer de toestemmingslaag wordt geopend |
Retourneren
CMPConsentTool
Voorbeeld
func onOpen() -> Void {
NSLog("APP:CLOSED");
// add custom business logic here
}
cmpConsentTool = CMPConsentTool(cmpConfig: cmpConfig, viewController: self)
.withCloseListener(onOpen)
metErrorListener
Voegt een foutluisteraar toe om meldingen te ontvangen wanneer er een fout is opgetreden
parameters
| Naam | Type | Omschrijving |
| foutListener | functie | Terugbellen om actie toe te voegen als er een fout is opgetreden. |
Retourneren
CMPConsentTool
Voorbeeld
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)
withOnCMPNotOpenedListener
Voegt een Cmp niet geopende callback toe om een melding te krijgen wanneer de toestemmingslaag niet wordt geopend
parameters
| Naam | Type | Omschrijving |
| openListener | functie | Callback die wordt aangeroepen wanneer de toestemmingslaag `niet geopend` is. De meest voorkomende reden is dat de gebruiker al toestemming heeft gegeven |
Retourneren
CMPConsentTool
Voorbeeld
func onCMPNotOpened() -> Void {
NSLog("APP:CLOSED");
// add custom business logic here
}
cmpConsentTool = CMPConsentTool(cmpConfig: cmpConfig, viewController: self)
.withOnCMPNotOpenedListener(onCMPNotOpened)
withOnCmpButtonClickedCallback
Stelt een callback in om meldingen te ontvangen wanneer de gebruiker op een knop klikt om de toestemmingslaag te sluiten.
parameters
| Naam | Type | Omschrijving |
| openListener | functie | Callback die wordt aangeroepen met de ``CmpButtonEvent`` die aangeeft op welke knop is gedrukt |
Retourneren
CMPConsentTool
Voorbeeld
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)
checkAndOpenConsentLayer
Controleer en open de toestemmingslaag
Retourneren
Geen retourwaarde
Voorbeeld
cmpConsentTool.checkAndOpenConsentLayer()
openCmpConsentToolView
Opent de weergave van de CMP-toestemmingslaag
Retourneren
Geen retourwaarde
Voorbeeld
cmpConsentTool.openView()
controle
Check
parameters
| Naam | Type | Omschrijving |
| opCmpLayerOpen | functie | Terugbellen wanneer de toestemmingslaag open moet zijn. |
| is in cache | Boolean | BOOL-vlag wanneer TRUE, wordt het verzoek in de cache opgeslagen en wordt het antwoord opgeslagen |
Retourneren
Geen retourwaarde
Voorbeeld
cmpConsentTool?.check({() -> Void in
print("Notification, that consent layer needs to be open")
}, isCached: false)
openCustomLayer
opent de aangepaste toestemmingslaag
parameters
| Naam | Type | Omschrijving |
| verband | Context | Toepassingscontext |
| appInterface | CmpLayerAppEventListenerInterface |
Retourneren
Geen retourwaarde
Voorbeeld
openCustomLayer(context = ...,appInterface = ...)
openConsentLayer
opent de toestemmingslaag
Retourneren
Geen retourwaarde
Voorbeeld
openConsentLayer()
createCustomLayerFragment
Maak een aangepast laagfragment
Retourneren
CmpLayerFragment
Voorbeeld
createCustomLayerFragment()
heeftToestemming
Controleert of de gebruiker toestemming heeft gegeven. De toestemmingslaag kan de optie hebben om de laag gewoon te sluiten. In dit geval heeft de gebruiker geen toestemming gegeven.
Retourneren
waar als de gebruiker toestemming heeft gegeven.
Voorbeeld
cmpConsentTool.hasConsent()
getAllPurposes
Haalt een door komma's gescheiden tekenreeks op van de uitgeschakelde `doel`-ID's
Retourneren
Tekenreeks van alle `doel`-ID's
Voorbeeld
cmpConsentTool.getAllPurposes()
getAllPurposeList
Haalt een lijst op van alle `doel`-ID's voor de gegeven Cmp.
Retourneren
Een `Lijst` met alle `purpose` ID's.
Voorbeeld
cmpConsentTool.getAllPurposeList()
getEnabledPurposes
Haalt een door komma's gescheiden tekenreeks op van de ingeschakelde `doel`-ID's
Retourneren
'String' van ingeschakelde 'purpose'-ID's
Voorbeeld
getEnabledPurposes()
getEnabledPurposeList
Ontvang een lijst met overeengekomen doelen
Retourneren
Voorbeeld
getEnabledPurposeList()
getDisabledPurposes
Krijg uitgeschakelde doeleinden
Retourneren
Voorbeeld
getDisabledPurposes()
getAllVendors
Krijg alle leveranciers
Retourneren
Voorbeeld
getAllVendors()
getAllVendorsList
Krijg alle leverancierslijst
Retourneren
Voorbeeld
getAllVendorsList()
getEnabledVendors
Krijg overeengekomen leveranciers
Retourneren
Voorbeeld
getEnabledVendors()
getEnabledVendorList
Ontvang een overeengekomen leverancierslijst
Retourneren
Voorbeeld
getEnabledVendorList()
getDisabledVendors
Krijg uitgeschakelde leveranciers
Retourneren
Voorbeeld
getDisabledVendors()
leverancierslijst inschakelen
Maakt een lijst met leveranciers mogelijk en werkt de gegeven toestemming bij
parameters
| Naam | Type | Omschrijving |
| vendors | reeks | Lijst met leveranciers-ID's die moeten worden ingeschakeld. |
| opVoltooien | functie | Terugbellen voor het afhandelen van een gebeurtenis met ontvangen toestemming. het wordt gebeld wanneer toestemming is ontvangen en verwerkt. |
Retourneren
Geen retourwaarde
Voorbeeld
func onFinish() -> Void {
NSLog("Notification, that new consent is received");
}
let vendors = ["1","2"]
cmpConsentTool?.enableVendorList(vendors, onFinish: onFinish)
leverancierslijst uitschakelen
Schakelt een lijst met leveranciers uit en werkt de gegeven toestemming bij
parameters
| Naam | Type | Omschrijving |
| vendors | reeks | Lijst met leveranciers-ID's die moeten worden uitgeschakeld. |
| opVoltooien | functie | Terugbellen voor het afhandelen van een gebeurtenis met ontvangen toestemming. het wordt gebeld wanneer toestemming is ontvangen en verwerkt. |
Retourneren
Geen retourwaarde
Voorbeeld
func onFinish() -> Void {
NSLog("Notification, that new consent is received");
}
let vendors = ["1","2"]
cmpConsentTool?.disableVendorList(vendors, onFinish: onFinish)
enablePurposeList
Maakt een lijst met doeleinden mogelijk en werkt de gegeven toestemming bij
parameters
| Naam | Type | Omschrijving |
| doeleinden | reeks | Lijst met doel-ID's die moeten worden ingeschakeld. |
| opVoltooien | functie (Optioneel) | Terugbellen voor het afhandelen van een gebeurtenis met ontvangen toestemming. het wordt gebeld wanneer toestemming is ontvangen en verwerkt. |
Retourneren
Geen retourwaarde
Voorbeeld
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)
uitschakelenPurposeList
Schakelt een lijst met doeleinden uit en werkt de gegeven toestemming bij
parameters
| Naam | Type | Omschrijving |
| doeleinden | reeks | Lijst met doel-ID's die moeten worden uitgeschakeld. |
| opVoltooien | functie (Optioneel) | Terugbellen voor het afhandelen van een gebeurtenis met ontvangen toestemming. het wordt gebeld wanneer toestemming is ontvangen en verwerkt. |
Retourneren
Geen retourwaarde
Voorbeeld
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)
weigerAlles
Weigert de toestemmingslaag en gedraagt zich hetzelfde wanneer de gebruiker de toestemming `niet accepteerde`
parameters
| Naam | Type | Omschrijving |
| opVoltooien | functie | Terugbellen voor het afhandelen van een gebeurtenis met ontvangen toestemming. het wordt gebeld wanneer toestemming is ontvangen en verwerkt. |
Retourneren
Geen retourwaarde
Voorbeeld
func onFinish() -> Void {
NSLog("Notification, that new consent is received");
}
cmpConsentTool.rejectAll(onFinish)
accepteer alles
Accepteert de toestemmingslaag en gedraagt zich hetzelfde wanneer de gebruiker de toestemming 'deed accepteren'
parameters
| Naam | Type | Omschrijving |
| opVoltooien | functie | Terugbellen voor het afhandelen van een gebeurtenis met ontvangen toestemming. het wordt gebeld wanneer toestemming is ontvangen en verwerkt. |
Retourneren
Geen retourwaarde
Voorbeeld
func onFinish() -> Void {
NSLog("Notification, that new consent is received");
}
cmpConsentTool.acceptAll(onFinish)
getUSPrivacyString
Download de Amerikaanse privacystring
Retourneren
`String` De Amerikaanse privacystring, die is ingesteld door consentmanager
Voorbeeld
cmpConsentTool.getUSPrivacyString()
heeftVendorConsent
Heeft toestemming van de verkoper
parameters
| Naam | Type | Omschrijving |
| verkopers ID | Draad | verkopers ID |
| leverancierIsV1ofV2 | BOOl | als leverancier-ID een IAB-leverancier is. (verouderd: de vlag is niet meer nodig) |
Retourneren
TRUE als de gebruiker toestemming heeft gegeven aan de opgegeven leverancier, anders FALSE.
Voorbeeld
cmpConsentTool.hasVendorConsent("vendorID", FALSE)
heeftPurposeConsent
Controleert of de doel-ID is ingeschakeld op basis van de toestemming van de gebruiker.
parameters
| Naam | Type | Omschrijving |
| doelId | Draad | doel-id |
| leverancierIsV1ofV2 | BOOl | als leverancier-ID een IAB-leverancier is. (verouderd: de vlag is niet meer nodig) |
Retourneren
Voorbeeld
cmpConsentTool.hasPurposeConsent("purposeID", FALSE)
getGoogleACString
Haalt de Google add-ID (`addtlConsent`) string op die is ingesteld door de consent manager.
Retourneren
Google AC-tekenreeks
Voorbeeld
cmpConsentTool.getGoogleACString()
getConsentstring
Haal de laatste tekenreeks voor toestemming op
Retourneren
opgeslagen toestemmingsreeks
Voorbeeld
getConsentstring()
exportCmpString
Exporteert de CmpData-tekenreeks
Retourneren
De CmpData String base64 gecodeerd
Voorbeeld
CMPConsentTool.exportCmpString()
genaamdThisDay
Controleert of de toestemmingslaag vandaag is aangeroepen
Retourneren
TRUE als de CMPConsent Manager Server is vandaag aangevraagd, anders FALSE
Voorbeeld
cmpConsentTool.calledThisDay()
heeft Acceptatie nodig
Controleert of de gebruiker acceptatie nodig heeft
Retourneren
TRUE als de gebruiker toestemming moet geven.
Voorbeeld
cmpConsentTool.needsAcceptance()
opnieuw in te stellen
Reset alle gegevens die zijn ingesteld door de ``CMPConsentTool``
Retourneren
Geen retourwaarde
Voorbeeld
CMPConsentTool.reset()
