Class InternalVendor
-
- All Implemented Interfaces:
-
io.didomi.sdk.models.Namespaceable
public final class InternalVendor implements Namespaceable
Model for vendors, used internally by Didomi SDK
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public final classInternalVendor.DataRetentionData Retention detail.
-
Field Summary
Fields Modifier and Type Field Description private transient List<String>essentialPurposeIdsprivate transient DeviceStorageDisclosuresdeviceStorageDisclosuresprivate transient BooleanisDeviceStorageDisclosureCompleteprivate final BooleanisIabVendorprivate final BooleanhasLegIntClaimprivate Stringidprivate final Stringnameprivate final StringprivacyPolicyUrlprivate Stringnamespaceprivate Vendor.Namespacesnamespacesprivate List<String>purposeIdsprivate List<String>legIntPurposeIdsprivate StringiabIdprivate List<String>flexiblePurposeIdsprivate final List<String>specialPurposeIdsprivate final List<String>featureIdsprivate List<String>specialFeatureIdsprivate final LongcookieMaxAgeSecondsprivate final BooleanusesNonCookieAccessprivate final StringdeviceStorageDisclosureUrlprivate final Set<String>dataDeclarationprivate final InternalVendor.DataRetentiondataRetentionprivate final List<Vendor.Url>urlsprivate final StringdidomiId
-
Constructor Summary
Constructors Constructor Description InternalVendor(String id, String name, String privacyPolicyUrl, String namespace, Vendor.Namespaces namespaces, List<String> purposeIds, List<String> legIntPurposeIds, String iabId, List<String> flexiblePurposeIds, List<String> specialPurposeIds, List<String> featureIds, List<String> specialFeatureIds, Long cookieMaxAgeSeconds, Boolean usesNonCookieAccess, String deviceStorageDisclosureUrl, Set<String> dataDeclaration, InternalVendor.DataRetention dataRetention, List<Vendor.Url> urls, String didomiId)
-
Method Summary
Modifier and Type Method Description final List<String>getEssentialPurposeIds()Purposes which are essential instead of consent / LI (cannot be accepted / refused) final UnitsetEssentialPurposeIds(List<String> essentialPurposeIds)Purposes which are essential instead of consent / LI (cannot be accepted / refused) final DeviceStorageDisclosuresgetDeviceStorageDisclosures()Retrieved device storage disclosures list final UnitsetDeviceStorageDisclosures(DeviceStorageDisclosures deviceStorageDisclosures)Retrieved device storage disclosures list final BooleanisDeviceStorageDisclosureComplete()final UnitsetDeviceStorageDisclosureComplete(Boolean isDeviceStorageDisclosureComplete)Whether the device storage disclosure list is already retrieved from URL final BooleanisIabVendor()final BooleangetHasLegIntClaim()final StringgetId()Vendor id used internally by Didomi. final UnitsetId(@SerializedName(value = "id") String id)Vendor id used internally by Didomi. final StringgetName()final StringgetPrivacyPolicyUrl()final StringgetNamespace()Vendor namespace (iab, didomi or custom) final UnitsetNamespace(@SerializedName(value = "namespace") String namespace)Vendor namespace (iab, didomi or custom) Vendor.NamespacesgetNamespaces()Vendor namespace (iab, didomi or custom) UnitsetNamespaces(@SerializedName(value = "namespaces") Vendor.Namespaces namespaces)Vendor namespace (iab, didomi or custom) final List<String>getPurposeIds()Purposes with legal basis "consent" final UnitsetPurposeIds(@SerializedName(value = "purposeIds", alternate = {"purposes"}) List<String> purposeIds)Purposes with legal basis "consent" final List<String>getLegIntPurposeIds()Purposes with legal basis "legitimate interest" final UnitsetLegIntPurposeIds(@SerializedName(value = "legIntPurposeIds", alternate = {"legIntPurposes"}) List<String> legIntPurposeIds)Purposes with legal basis "legitimate interest" final StringgetIabId()For custom or Didomi vendors, we allow mapping back to IAB IDs to override IAB vendors definition final UnitsetIabId(@SerializedName(value = "iabId") String iabId)For custom or Didomi vendors, we allow mapping back to IAB IDs to override IAB vendors definition final List<String>getFlexiblePurposeIds()Set with IDs that represent flexible purposes. final UnitsetFlexiblePurposeIds(@SerializedName(value = "flexiblePurposeIds", alternate = {"flexiblePurposes"}) List<String> flexiblePurposeIds)Set with IDs that represent flexible purposes. final List<String>getSpecialPurposeIds()Set with IDs that represent Special Purposes. final List<String>getFeatureIds()Set with IDs that represent features. final List<String>getSpecialFeatureIds()Set with IDs that represent Special Features. final UnitsetSpecialFeatureIds(@SerializedName(value = "specialFeatureIds", alternate = {"specialFeatures"}) List<String> specialFeatureIds)Set with IDs that represent Special Features. final LonggetCookieMaxAgeSeconds()Cookie Max Age in Seconds. final BooleangetUsesNonCookieAccess()If vendor uses other means of storage/access than cookies. final StringgetDeviceStorageDisclosureUrl()URL used to download Device Storage Disclosures (done post initialization). final Set<String>getDataDeclaration()Property introduced in TCFv2.2. final InternalVendor.DataRetentiongetDataRetention()Property introduced in TCFv2.2. final List<Vendor.Url>getUrls()Property introduced in TCFv2.2. final StringgetDidomiId()Property injected into the Didomi GVL to allow exposing only Didomi IDs through our new public API methods. -
-
Constructor Detail
-
InternalVendor
InternalVendor(String id, String name, String privacyPolicyUrl, String namespace, Vendor.Namespaces namespaces, List<String> purposeIds, List<String> legIntPurposeIds, String iabId, List<String> flexiblePurposeIds, List<String> specialPurposeIds, List<String> featureIds, List<String> specialFeatureIds, Long cookieMaxAgeSeconds, Boolean usesNonCookieAccess, String deviceStorageDisclosureUrl, Set<String> dataDeclaration, InternalVendor.DataRetention dataRetention, List<Vendor.Url> urls, String didomiId)
-
-
Method Detail
-
getEssentialPurposeIds
final List<String> getEssentialPurposeIds()
Purposes which are essential instead of consent / LI (cannot be accepted / refused)
-
setEssentialPurposeIds
final Unit setEssentialPurposeIds(List<String> essentialPurposeIds)
Purposes which are essential instead of consent / LI (cannot be accepted / refused)
-
getDeviceStorageDisclosures
final DeviceStorageDisclosures getDeviceStorageDisclosures()
Retrieved device storage disclosures list
-
setDeviceStorageDisclosures
final Unit setDeviceStorageDisclosures(DeviceStorageDisclosures deviceStorageDisclosures)
Retrieved device storage disclosures list
-
isDeviceStorageDisclosureComplete
final Boolean isDeviceStorageDisclosureComplete()
-
setDeviceStorageDisclosureComplete
final Unit setDeviceStorageDisclosureComplete(Boolean isDeviceStorageDisclosureComplete)
Whether the device storage disclosure list is already retrieved from URL
-
isIabVendor
final Boolean isIabVendor()
-
getHasLegIntClaim
final Boolean getHasLegIntClaim()
-
setId
final Unit setId(@SerializedName(value = "id") String id)
Vendor id used internally by Didomi.
-
getPrivacyPolicyUrl
final String getPrivacyPolicyUrl()
-
getNamespace
final String getNamespace()
Vendor namespace (iab, didomi or custom)
-
setNamespace
final Unit setNamespace(@SerializedName(value = "namespace") String namespace)
Vendor namespace (iab, didomi or custom)
-
getNamespaces
Vendor.Namespaces getNamespaces()
Vendor namespace (iab, didomi or custom)
-
setNamespaces
Unit setNamespaces(@SerializedName(value = "namespaces") Vendor.Namespaces namespaces)
Vendor namespace (iab, didomi or custom)
-
getPurposeIds
final List<String> getPurposeIds()
Purposes with legal basis "consent"
-
setPurposeIds
final Unit setPurposeIds(@SerializedName(value = "purposeIds", alternate = {"purposes"}) List<String> purposeIds)
Purposes with legal basis "consent"
-
getLegIntPurposeIds
final List<String> getLegIntPurposeIds()
Purposes with legal basis "legitimate interest"
-
setLegIntPurposeIds
final Unit setLegIntPurposeIds(@SerializedName(value = "legIntPurposeIds", alternate = {"legIntPurposes"}) List<String> legIntPurposeIds)
Purposes with legal basis "legitimate interest"
-
getIabId
final String getIabId()
For custom or Didomi vendors, we allow mapping back to IAB IDs to override IAB vendors definition
-
setIabId
final Unit setIabId(@SerializedName(value = "iabId") String iabId)
For custom or Didomi vendors, we allow mapping back to IAB IDs to override IAB vendors definition
-
getFlexiblePurposeIds
final List<String> getFlexiblePurposeIds()
Set with IDs that represent flexible purposes. TCFv2 property.
-
setFlexiblePurposeIds
final Unit setFlexiblePurposeIds(@SerializedName(value = "flexiblePurposeIds", alternate = {"flexiblePurposes"}) List<String> flexiblePurposeIds)
Set with IDs that represent flexible purposes. TCFv2 property.
-
getSpecialPurposeIds
final List<String> getSpecialPurposeIds()
Set with IDs that represent Special Purposes. TCFv2 property.
-
getFeatureIds
final List<String> getFeatureIds()
Set with IDs that represent features.
-
getSpecialFeatureIds
final List<String> getSpecialFeatureIds()
Set with IDs that represent Special Features. TCFv2 property.
-
setSpecialFeatureIds
final Unit setSpecialFeatureIds(@SerializedName(value = "specialFeatureIds", alternate = {"specialFeatures"}) List<String> specialFeatureIds)
Set with IDs that represent Special Features. TCFv2 property.
-
getCookieMaxAgeSeconds
final Long getCookieMaxAgeSeconds()
Cookie Max Age in Seconds.
-
getUsesNonCookieAccess
final Boolean getUsesNonCookieAccess()
If vendor uses other means of storage/access than cookies.
-
getDeviceStorageDisclosureUrl
final String getDeviceStorageDisclosureUrl()
URL used to download Device Storage Disclosures (done post initialization).
-
getDataDeclaration
final Set<String> getDataDeclaration()
Property introduced in TCFv2.2.
-
getDataRetention
final InternalVendor.DataRetention getDataRetention()
Property introduced in TCFv2.2.
-
getUrls
final List<Vendor.Url> getUrls()
Property introduced in TCFv2.2.
-
getDidomiId
final String getDidomiId()
Property injected into the Didomi GVL to allow exposing only Didomi IDs through our new public API methods.
-
-
-
-