[iOS] 3. API-dokumentation
API
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
cmpConsentTool = CMPConsentTool(cmpConfig: cmpConfig, viewController: self)
.initialize()
med CloseListener
Lägger till en nära lyssnare för att få aviseringar när samtyckeslagret stängs.
parametrar
| Namn | 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
| Namn | 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
| Namn | 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
| Namn | 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
| Namn | 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)
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
| Namn | 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({() -> Void in
print("Notification, that consent layer needs to be open")
}, isCached: false)
openCustomLayer
öppnar det anpassade samtyckeslagret
parametrar
| Namn | Typ | Beskrivning |
| sammanhang | Sammanhang | Applikationskontext |
| appgränssnitt | CmpLayerAppEventListenerInterface |
Retur
Inget returvärde
Exempelvis
openCustomLayer(context = ...,appInterface = ...)
openConsentLayer
öppnar samtyckesskiktet
Retur
Inget returvärde
Exempelvis
openConsentLayer()
skapa CustomLayerFragment
Skapa anpassat lagerfragment
Retur
CmpLayerFragment
Exempelvis
createCustomLayerFragment()
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
sant om användaren gett sitt samtycke.
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
getEnabledPurposes()
getEnabledPurposeList
Få överenskommen syfteslista
Retur
Exempelvis
getEnabledPurposeList()
getDisabledPurposes
Få funktionshindrade syften
Retur
Exempelvis
getDisabledPurposes()
getAllVendors
Få alla leverantörer
Retur
Exempelvis
getAllVendors()
getAllVendorsList
Hämta listan över alla leverantörer
Retur
Exempelvis
getAllVendorsList()
getEnabledVendors
Skaffa överenskomna leverantörer
Retur
Exempelvis
getEnabledVendors()
getEnabledVendorList
Få överenskommen leverantörslista
Retur
Exempelvis
getEnabledVendorList()
getDisabledVendors
Skaffa funktionshindrade leverantörer
Retur
Exempelvis
getDisabledVendors()
aktiveraVendorList
Aktiverar en lista över leverantörer och uppdaterar det givna samtycket
parametrar
| Namn | 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
| Namn | 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
| Namn | 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
| Namn | 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
| Namn | 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
| Namn | 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
| Namn | 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
TRUE om användaren har gett sitt samtycke till den angivna leverantören, FALSK annars.
Exempelvis
cmpConsentTool.hasVendorConsent("vendorID", FALSE)
hasPurposeConsent
Kontrollerar om ändamåls-ID är aktiverat baserat på användarens samtycke.
parametrar
| Namn | 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", FALSE)
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
sparad samtyckessträng
Exempelvis
getConsentstring()
exportCmpString
Exporterar CmpData-strängen
Retur
CmpData String base64-kodad
Exempelvis
CMPConsentTool.exportCmpString()
kallas ThisDay
Kontrollerar om samtyckesskiktet anropades idag
Retur
SANT om CMPConsent Manager Servern begärdes idag, annars FALSK
Exempelvis
cmpConsentTool.calledThisDay()
behöver Acceptans
Kontrollerar om användaren behöver accepteras
Retur
SANT om användaren behöver ge ett samtycke.
Exempelvis
cmpConsentTool.needsAcceptance()
återställa
Återställer all data som ställts in av ``CMPConsentTool``
Retur
Inget returvärde
Exempelvis
CMPConsentTool.reset()
