io.didomi.sdk

Class Vendor

java.lang.Object

io.didomi.sdk.Vendor

public class Vendor
extends java.lang.Object

Model class for vendors

Constructor Summary

Constructors

Constructor and Description
Vendor(java.lang.String id, java.lang.String name, java.lang.String privacyPolicyUrl, java.lang.String namespace, java.util.List<java.lang.String> purposeIds, java.util.List<java.lang.String> legIntPurposeIds, java.util.List<java.lang.String> featureIds, java.util.List<java.lang.String> flexiblePurposeIds, java.util.List<java.lang.String> specialPurposeIds, java.util.List<java.lang.String> specialFeatureIds, java.lang.String iabId, io.didomi.sdk.models.VendorNamespaces namespaces, java.lang.Long cookieMaxAgeSeconds, java.lang.Boolean usesNonCookieAccess, java.lang.String deviceStorageDisclosureUrl)
Vendor(java.lang.String id, java.lang.String name, java.lang.String privacyPolicyUrl, java.lang.String namespace, java.util.List<java.lang.String> purposeIds, java.util.List<java.lang.String> legIntPurposeIds, java.lang.String iabId, io.didomi.sdk.models.VendorNamespaces namespaces)

Method Summary

Modifier and Type	Method and Description
java.lang.Long	getCookieMaxAgeSeconds()
io.didomi.sdk.models.DeviceStorageDisclosures	getDeviceStorageDisclosures()
java.lang.String	getDeviceStorageDisclosureUrl()
java.util.List<java.lang.String>	getEssentialPurposeIds() Purposes which are essential instead of consent / LI (cannot be accepted / refused)
java.util.List<java.lang.String>	getFeatureIds()
java.util.List<java.lang.String>	getFlexiblePurposeIds()
java.lang.String	getIabId() For custom or Didomi vendors, we allow mapping back to IAB IDs to override IAB vendors definition
java.lang.String	getId() Id of the vendor
java.util.List<java.lang.String>	getLegIntPurposeIds() Purposes with legal basis "legitimate interest"
java.lang.String	getName() Displayable name of the vendor
java.lang.String	getNamespace() Namespace where the vendor is defined (iab, didomi...)
io.didomi.sdk.models.VendorNamespaces	getNamespaces() Namespaces with which vendor should be merged
java.lang.String	getPrivacyPolicyUrl() URL of the vendor's privacy policy
java.util.List<java.lang.String>	getPurposeIds() Purposes with legal basis "consent"
java.util.List<java.lang.String>	getSpecialFeatureIds()
java.util.List<java.lang.String>	getSpecialPurposeIds()
boolean	getUsesNonCookieAccess()
boolean	isDeviceStorageDisclosureComplete()
boolean	isIABVendor() Whether vendor is from IAB namespace
void	mergeWithDidomiVendor(Vendor didomiVendor) Set info from Didomi to a IAB vendor
void	setFlexiblePurposeIds(java.util.List<java.lang.String> flexiblePurposeIds)
void	setId(java.lang.String id)
void	setLegIntPurposeIds(java.util.List<java.lang.String> legIntPurposeIds)
void	setNamespace(java.lang.String namespace)
void	setPurposeIds(java.util.List<java.lang.String> purposeIds)
void	setSpecialFeatureIds(java.util.List<java.lang.String> specialFeatureIds)
java.lang.String	toString()
void	updateDeviceStorageDisclosures(io.didomi.sdk.models.DeviceStorageDisclosures disclosures)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

Vendor

public Vendor(java.lang.String id,
              java.lang.String name,
              java.lang.String privacyPolicyUrl,
              java.lang.String namespace,
              java.util.List<java.lang.String> purposeIds,
              java.util.List<java.lang.String> legIntPurposeIds,
              java.util.List<java.lang.String> featureIds,
              java.util.List<java.lang.String> flexiblePurposeIds,
              java.util.List<java.lang.String> specialPurposeIds,
              java.util.List<java.lang.String> specialFeatureIds,
              java.lang.String iabId,
              io.didomi.sdk.models.VendorNamespaces namespaces,
              java.lang.Long cookieMaxAgeSeconds,
              java.lang.Boolean usesNonCookieAccess,
              java.lang.String deviceStorageDisclosureUrl)

Vendor

public Vendor(java.lang.String id,
              java.lang.String name,
              java.lang.String privacyPolicyUrl,
              java.lang.String namespace,
              java.util.List<java.lang.String> purposeIds,
              java.util.List<java.lang.String> legIntPurposeIds,
              java.lang.String iabId,
              io.didomi.sdk.models.VendorNamespaces namespaces)

Method Detail

getId

public java.lang.String getId()

Id of the vendor

Returns:

id

setId

public void setId(java.lang.String id)

getName

public java.lang.String getName()

Displayable name of the vendor

Returns:

name

getPrivacyPolicyUrl

public java.lang.String getPrivacyPolicyUrl()

URL of the vendor's privacy policy

Returns:

url

getNamespace

public java.lang.String getNamespace()

Namespace where the vendor is defined (iab, didomi...)

Returns:

namespace

getNamespaces

public io.didomi.sdk.models.VendorNamespaces getNamespaces()

Namespaces with which vendor should be merged

Returns:

namespaces to merge

isIABVendor

public boolean isIABVendor()

Whether vendor is from IAB namespace

Returns:

true if vendor is from the IAB namespace

getPurposeIds

public java.util.List<java.lang.String> getPurposeIds()

Purposes with legal basis "consent"

Returns:

list of purpose ids

getLegIntPurposeIds

public java.util.List<java.lang.String> getLegIntPurposeIds()

Purposes with legal basis "legitimate interest"

Returns:

list of purpose ids

getEssentialPurposeIds

public java.util.List<java.lang.String> getEssentialPurposeIds()

Purposes which are essential instead of consent / LI (cannot be accepted / refused)

Returns:

list of purpose ids

setPurposeIds

public void setPurposeIds(java.util.List<java.lang.String> purposeIds)

setLegIntPurposeIds

public void setLegIntPurposeIds(java.util.List<java.lang.String> legIntPurposeIds)

setNamespace

public void setNamespace(java.lang.String namespace)

getIabId

@Nullable
public java.lang.String getIabId()

For custom or Didomi vendors, we allow mapping back to IAB IDs to override IAB vendors definition

Returns:

the IAB id if vendor is not IAB and has an assigned IAB id ; null otherwise

getFeatureIds

public java.util.List<java.lang.String> getFeatureIds()

getFlexiblePurposeIds

public java.util.List<java.lang.String> getFlexiblePurposeIds()

setFlexiblePurposeIds

public void setFlexiblePurposeIds(java.util.List<java.lang.String> flexiblePurposeIds)

setSpecialFeatureIds

public void setSpecialFeatureIds(java.util.List<java.lang.String> specialFeatureIds)

getSpecialPurposeIds

public java.util.List<java.lang.String> getSpecialPurposeIds()

getSpecialFeatureIds

public java.util.List<java.lang.String> getSpecialFeatureIds()

getCookieMaxAgeSeconds

public java.lang.Long getCookieMaxAgeSeconds()

getUsesNonCookieAccess

public boolean getUsesNonCookieAccess()

getDeviceStorageDisclosureUrl

public java.lang.String getDeviceStorageDisclosureUrl()

isDeviceStorageDisclosureComplete

public boolean isDeviceStorageDisclosureComplete()

getDeviceStorageDisclosures

public io.didomi.sdk.models.DeviceStorageDisclosures getDeviceStorageDisclosures()

updateDeviceStorageDisclosures

public void updateDeviceStorageDisclosures(io.didomi.sdk.models.DeviceStorageDisclosures disclosures)

mergeWithDidomiVendor

public void mergeWithDidomiVendor(@NonNull
                                  Vendor didomiVendor)

Set info from Didomi to a IAB vendor

Parameters:

didomiVendor - Didomi vendor to merge

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object