usercentrics_sdk library

The Usercentrics Apps SDK is a Consent Management Platform framework that ensures legal compliance for different legal frameworks.

Get started at usercentrics.com 🚀

Classes

AdditionalConsentModeData
AdTechProvider
AdTechProviderDecision
BannerFont
An asset font that Usercentrics can load. It consists of a regularFontAssetPath, a boldFontAssetPath and fontSize.
BannerImage
It consists of a assetPath.
BannerSettings
The Banner Settings.
ButtonLayout
The button layout.
ButtonSettings
The button settings.
CCPAData
The User's CCPA consent data.
CCPASettings
ConsentDisclosure
ConsentDisclosureObject
CustomizationColor
CustomizationFont
DataRetention
FirstLayer
FirstLayerStyleSettings
The First Layer Settings.
GeneralStyleSettings
The General Style Settings.
GeolocationRuleset
HeaderImageSettings
The header image settings.
MessageSettings
The message settings.
PublishedApp
RetentionPeriod
SecondLayer
SecondLayerStyleSettings
The Second Layer Settings.
TCF2ChangedPurposes
TCF2Settings
TCFData
All the data that needs to be disclosed to the end-user if TCF is enabled.
TCFFeature
A TCF feature that needs to be disclosed to the end-user.
TCFPurpose
TCF purpose that needs to be disclosed to the end-user and requires the end-user's consent and legitimate interest consent.
TCFSpecialFeature
A TCF special feature that needs to be disclosed to the end-user and requires the end-user's consent.
TCFSpecialPurpose
A TCF special purpose that needs to be disclosed to the end-user.
TCFStack
A TCF stack is a collection of multiple TCF purposes and TCF special features, with one shared description. On the first layer of a TCF UI, stacks may be shown as alternative to the included single purposes and special features.
TCFUserDecisionOnPurpose
The user consent decision for a single purpose.
TCFUserDecisionOnSpecialFeature
The user consent decision for a single special feature.
TCFUserDecisionOnVendor
The user consent decision for a single vendor.
TCFUserDecisions
The user consent decision on all TCF options.
TCFVendor
A TCF vendor (aka. advertiser, tracking service, third party) that is registered with the IAB global vendor list. A TCF vendor needs to be disclosed to the end-user and requires the end-user's consent and legitimate interest consent.
TCFVendorRestriction
TitleSettings
The title settings.
ToggleStyleSettings
Usercentrics
The the entry point class for Usercentrics SDK.
UsercentricsCategory
A service category.
UsercentricsCMPData
The CMP data.
UsercentricsConsentHistoryEntry
The consent history entry
UsercentricsConsentUserResponse
The response of the user to the CMP.
UsercentricsCustomization
UsercentricsLabels
UsercentricsLocation
The location of the user.
UsercentricsPlatform
UsercentricsReadyStatus
The current status of the user.
UsercentricsService
A service.
UsercentricsServiceConsent
The current status of a service.
UsercentricsSettings
The general settings defined for the settingsId.
UserDecision
The user consent decision about a service.
VariantsSettings
VendorUrl