Informacia
Treść

[iOS] 3. Dokumentacja API

API


 

zainicjować


Funkcja inicjalizacji zainicjuje warstwę zgody i automatycznie sprawdzi, czy użytkownik potrzebuje zgody, czy nie. Ta funkcja ostatecznie otworzy warstwę zgody i wejdzie w interakcję z interfejsem Apple Tracking Transparency API, aby poprosić użytkownika o zgodę

Powrót

Narzędzie CMPConsent

Przykład

          cmpConsentTool = CMPConsentTool(cmpConfig: cmpConfig, viewController: self)
            .initialize()

 

z CloseListener


Dodaje bliskiego słuchacza, który będzie otrzymywać powiadomienia, gdy warstwa zgody zostanie zamknięta.

parametry
Imię i nazwisko Typ Opis
zamknij Słuchacz funkcjonować Wywołanie zwrotne, które zostanie wywołane po zamknięciu warstwy zgody.
Powrót

Narzędzie CMPConsent

Przykład

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

z OpenListenerem


Dodaje otwartego odbiornika, który będzie otrzymywać powiadomienia o otwarciu warstwy zgody.

parametry
Imię i nazwisko Typ Opis
Otwórz słuchacza funkcjonować Wywołanie zwrotne, które zostanie wywołane po otwarciu warstwy zgody
Powrót

Narzędzie CMPConsent

Przykład

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

 

 

withErrorListener


Dodaje odbiornik błędów, aby otrzymywać powiadomienia o wystąpieniu błędu

parametry
Imię i nazwisko Typ Opis
słuchacz błędów funkcjonować Wywołanie zwrotne w celu dodania akcji w przypadku wystąpienia błędu.
Powrót

Narzędzie CMPConsent

Przykład

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)

 

 

 

z OnCMMPNotOpenedListener


Dodaje wywołanie zwrotne Cmp, które nie zostało otwarte, aby otrzymywać powiadomienia, gdy warstwa zgody się nie otwiera

parametry
Imię i nazwisko Typ Opis
Otwórz słuchacza funkcjonować Wywołanie zwrotne, które zostanie wywołane, gdy warstwa zgody nie zostanie otwarta. Najczęstszym powodem jest to, że użytkownik wyraził już zgodę
Powrót

Narzędzie CMPConsent

Przykład

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

 

 

 

z OnCmpButtonClickedCallback


Ustawia wywołanie zwrotne w celu otrzymywania powiadomień, gdy użytkownik kliknie przycisk w celu zamknięcia warstwy zgody.

parametry
Imię i nazwisko Typ Opis
Otwórz słuchacza funkcjonować Wywołanie zwrotne, które zostanie wywołane z ``CmpButtonEvent`` wskazującym, który przycisk został naciśnięty
Powrót

Narzędzie CMPConsent

Przykład

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


Sprawdź i otwórz warstwę zgody

Powrót

Brak wartości zwracanej

Przykład
cmpConsentTool.checkAndOpenConsentLayer()

 

openCmpConsentToolView


Otwiera widok warstwy zgody CMP

Powrót

Brak wartości zwracanej

Przykład
cmpConsentTool.openView()

 

ZOBACZ


Sprawdź

parametry
Imię i nazwisko Typ Opis
onCmpLayerOpen funkcjonować Oddzwanianie, gdy warstwa zgody musi być otwarta.
jest w pamięci podręcznej Boolean BOOL, gdy PRAWDA, żądanie zostanie zapisane w pamięci podręcznej, a odpowiedź zostanie zapisana
Powrót

Brak wartości zwracanej

Przykład

cmpConsentTool?.check({() -> Void in
  print("Notification, that consent layer needs to be open")
}, isCached: false)

 

otwórz warstwę niestandardową


otwiera dostosowaną warstwę zgody

parametry
Imię i nazwisko Typ Opis
kontekst Kontekst Kontekst aplikacji
interfejs aplikacji Interfejs CmpLayerAppEventListener  
Powrót

Brak wartości zwracanej

Przykład
openCustomLayer(context = ...,appInterface = ...)

 

openConsentLayer


otwiera warstwę zgody

Powrót

Brak wartości zwracanej

Przykład
openConsentLayer()

 

utwórzCustomLayerFragment


Utwórz niestandardowy fragment warstwy

Powrót

CmpLayerFragment

Przykład
createCustomLayerFragment()

 

ma zgodę


Sprawdza, czy użytkownik wyraził zgodę. Warstwa zgody może mieć opcję zamknięcia warstwy przez. W takim przypadku użytkownik nie wyraził zgody.

Powrót
Przykład
cmpConsentTool.hasConsent()

 

getAllPurposes


Pobiera oddzielony przecinkami łańcuch znaków wyłączonych identyfikatorów „przeznaczenia”.

Powrót

Ciąg wszystkich identyfikatorów „przeznaczenia”.

Przykład
cmpConsentTool.getAllPurposes()

 

getAllPurposeList


Pobiera listę wszystkich identyfikatorów „celu” dla danego Cmp.

Powrót

„Lista” zawierająca wszystkie identyfikatory „przeznaczenia”.

Przykład
cmpConsentTool.getAllPurposeList()

 

getEnabledPurposes


Pobiera oddzielony przecinkami ciąg znaków włączonych identyfikatorów „przeznaczenia”.

Powrót

`Ciąg` włączonych identyfikatorów `celu`

Przykład
getEnabledPurposes()

 

getEnabledPurposeList


Uzyskaj uzgodnioną listę celów

Powrót

 

Przykład
getEnabledPurposeList()

 

getDisabledPurposes


Zdobądź cele dla osób niepełnosprawnych

Powrót

 

Przykład
getDisabledPurposes()

 

getAllVendors


Zdobądź wszystkich dostawców

Powrót

 

Przykład
getAllVendors()

 

getAllVendorsList


Pobierz listę wszystkich dostawców

Powrót

 

Przykład
getAllVendorsList()

 

getEnabledVendors


Uzyskaj uzgodnionych dostawców

Powrót

 

Przykład
getEnabledVendors()

 

getEnabledVendorList


Uzyskaj uzgodnioną listę dostawców

Powrót

 

Przykład
getEnabledVendorList()

 

getDisabledVendors


Zdobądź wyłączonych dostawców

Powrót

 

Przykład
getDisabledVendors()

 

włącz listę dostawców


Włącza listę dostawców i aktualizuje udzieloną zgodę

parametry
Imię i nazwisko Typ Opis
sprzedawców Szyk Lista identyfikatorów dostawców do włączenia.
naZakończ funkcjonować Oddzwanianie do obsługi zdarzenia otrzymania zgody. zostanie wywołana po otrzymaniu i przetworzeniu zgody.
Powrót

Brak wartości zwracanej

Przykład

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

 

wyłącz listę dostawców


Wyłącza listę dostawców i aktualizuje udzieloną zgodę

parametry
Imię i nazwisko Typ Opis
sprzedawców Szyk Lista identyfikatorów dostawców do wyłączenia.
naZakończ funkcjonować Oddzwanianie do obsługi zdarzenia otrzymania zgody. zostanie wywołana po otrzymaniu i przetworzeniu zgody.
Powrót

Brak wartości zwracanej

Przykład

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

 

włącz listę celów


Włącza listę celów i aktualizuje udzieloną zgodę

parametry
Imię i nazwisko Typ Opis
cele Szyk Lista identyfikatorów celów do włączenia.
naZakończ funkcja (opcjonalnie) Oddzwanianie do obsługi zdarzenia otrzymania zgody. zostanie wywołana po otrzymaniu i przetworzeniu zgody.
Powrót

Brak wartości zwracanej

Przykład

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)

 

wyłącz listę celów


Wyłącza listę celów i aktualizuje udzieloną zgodę

parametry
Imię i nazwisko Typ Opis
cele Szyk Lista identyfikatorów celów do wyłączenia.
naZakończ funkcja (opcjonalnie) Oddzwanianie do obsługi zdarzenia otrzymania zgody. zostanie wywołana po otrzymaniu i przetworzeniu zgody.
Powrót

Brak wartości zwracanej

Przykład

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)

 

odrzuć wszystko


Odrzuca warstwę zgody i zachowuje się tak samo, gdy użytkownik „nie zaakceptował” zgody

parametry
Imię i nazwisko Typ Opis
naZakończ funkcjonować Oddzwanianie do obsługi zdarzenia otrzymania zgody. zostanie wywołana po otrzymaniu i przetworzeniu zgody.
Powrót

Brak wartości zwracanej

Przykład

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

 

Akceptuj wszystkie


Akceptuje warstwę zgody i zachowuje się tak samo, gdy użytkownik „zaakceptuje” zgodę

parametry
Imię i nazwisko Typ Opis
naZakończ funkcjonować Oddzwanianie do obsługi zdarzenia otrzymania zgody. zostanie wywołana po otrzymaniu i przetworzeniu zgody.
Powrót

Brak wartości zwracanej

Przykład

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

 

getUSPrivacyString


Uzyskaj amerykański ciąg znaków prywatności

Powrót

`String` Ciąg znaków prywatności USA, który został ustawiony przez consentmanager

Przykład
cmpConsentTool.getUSPrivacyString()

 

mazgodędostawcy


Posiada zgodę sprzedawcy

parametry
Imię i nazwisko Typ Opis
identyfikator sprzedawcy sznur identyfikator sprzedawcy
dostawcaJestV1lubV2 BOOl jeśli identyfikator dostawcy to dostawca IAB. (przestarzałe: flaga nie jest już potrzebna)
Powrót
Przykład
cmpConsentTool.hasVendorConsent("vendorID", FALSE)

 

maCelowązgodę


Sprawdza, czy identyfikator celu jest włączony na podstawie zgody użytkownika.

parametry
Imię i nazwisko Typ Opis
identyfikator celu sznur identyfikator celu
dostawcaJestV1lubV2 BOOl jeśli identyfikator dostawcy to dostawca IAB. (przestarzałe: flaga nie jest już potrzebna)
Powrót

 

Przykład
cmpConsentTool.hasPurposeConsent("purposeID", FALSE)

 

pobierz GoogleACString


Pobiera ciąg identyfikatora dodania Google (`addtlConsent`), który został ustawiony przez consent manager.

Powrót

Ciąg Google AC

Przykład
cmpConsentTool.getGoogleACString()

 

getConsentstring


Pobierz ostatni ciąg zgody

Powrót
Przykład
getConsentstring()

 

eksportCmpString


Eksportuje ciąg CmpData

Powrót

Ciąg znaków CmpData zakodowany w formacie base64

Przykład
CMPConsentTool.exportCmpString()

 

o nazwie ThisDay


Sprawdza, czy warstwa zgody została wywołana dzisiaj

Powrót

PRAWDA, jeśli plik CMPConsent Manager Żądanie serwera zostało wysłane dzisiaj, w przeciwnym razie FAŁSZ

Przykład
cmpConsentTool.calledThisDay()

 

potrzebuje Akceptacji


Sprawdza, czy użytkownik potrzebuje akceptacji

Powrót

PRAWDA, jeśli użytkownik musi wyrazić zgodę.

Przykład
cmpConsentTool.needsAcceptance()

 

nastawić


Resetuje wszystkie dane ustawione przez ``CMPConsentTool``

Powrót

Brak wartości zwracanej

Przykład
CMPConsentTool.reset()

 

Powrót do góry