public interface TCString
| Modifier and Type | Method | Description |
|---|---|---|
static TCString |
decode(String consentString,
DecoderOption... options) |
Decodes an iabtcf compliant encoded string.
|
IntIterable |
getAllowedVendors() |
Part of the OOB segments expressing that a Vendor is using legal bases outside of the TCF to
process personal data.
|
int |
getCmpId() |
Consent Management Platform ID that last updated the TC String
|
int |
getCmpVersion() |
Consent Management Platform version of the CMP that last updated this TC String
|
String |
getConsentLanguage() |
Two-letter ISO 639-1 language code in which the CMP UI was presented.
|
int |
getConsentScreen() |
CMP Screen number at which consent was given for a user with the CMP that last updated this
TC String.
|
Instant |
getCreated() |
Epoch deciseconds (0.1 of a second) when this TC String was first created
|
IntIterable |
getCustomPurposesConsent() |
Part of the Publisher Transparency and Consent segment of a TC String that publishers may use
to establish transparency with and receive consent from users for their own legal bases to
process personal data or to share with vendors if they so choose.
|
IntIterable |
getCustomPurposesLITransparency() |
Part of the Publisher Transparency and Consent segment of a TC String that publishers may use
to establish transparency with and receive consent from users for their own legal bases to
process personal data or to share with vendors if they so choose.
|
boolean |
getDefaultVendorConsent() |
Default consent for VendorIds not covered by a RangeEntry.
|
IntIterable |
getDisclosedVendors() |
Part of the OOB segments expressing that a Vendor is using legal bases outside of the TCF to
process personal data.
|
Instant |
getLastUpdated() |
Epoch deciseconds (0.1 of a second) when TC String was last updated
|
String |
getPublisherCC() |
The country code of the country that determines legislation of reference.
|
List<PublisherRestriction> |
getPublisherRestrictions() |
The restrictions of a vendor's data processing by a publisher within the context of the users
trafficking their digital property.
|
IntIterable |
getPubPurposesConsent() |
Part of the Publisher Transparency and Consent segment of a TC String that publishers may use
to establish transparency with and receive consent from users for their own legal bases to
process personal data or to share with vendors if they so choose.
|
IntIterable |
getPubPurposesLITransparency() |
Part of the Publisher Transparency and Consent segment of a TC String that publishers may use
to establish transparency with and receive consent from users for their own legal bases to
process personal data or to share with vendors if they so choose.
|
boolean |
getPurposeOneTreatment() |
CMPs can use the PublisherCC field to indicate the legal jurisdiction the publisher is under
to help vendors determine whether the vendor needs consent for Purpose 1.
|
IntIterable |
getPurposesConsent() |
The user’s consent value for each Purpose established on the legal basis of consent.
|
IntIterable |
getPurposesLITransparency() |
The Purpose’s transparency requirements are met for each Purpose on the legal basis of
legitimate interest and the user has not exercised their "Right to Object" to that Purpose.
|
IntIterable |
getSpecialFeatureOptIns() |
The TCF Policies designates certain Features as "special" which means a CMP must afford the
user a means to opt in to their use.
|
int |
getTcfPolicyVersion() |
From the corresponding field in the GVL that was used for obtaining consent.
|
boolean |
getUseNonStandardStacks() |
Setting this to field to true means that a publisher-run CMP – that is still IAB Europe
registered – is using customized Stack descriptions and not the standard stack descriptions
defined in the Policies (Appendix A section E).
|
IntIterable |
getVendorConsent() |
The vendor identifiers that have consent to process this users personal data.
|
IntIterable |
getVendorLegitimateInterest() |
If a user exercises their "Right To Object" to a vendor’s processing based on a legitimate
interest.
|
int |
getVendorListVersion() |
Number corresponds to GVL vendorListVersion.
|
int |
getVersion() |
Version number of the encoding format
|
boolean |
isServiceSpecific() |
Whether the signals encoded in this TC String were from service-specific storage versus
global consesu.org shared storage.
|
static TCString decode(String consentString, DecoderOption... options) throws IllegalArgumentException, ByteParseException, UnsupportedVersionException
ByteParseException - if version field failed to parseUnsupportedVersionException - invalid version fieldIllegalArgumentException - if consentString is not in valid Base64 schemeint getVersion()
TCStringDecodeExceptionInstant getCreated()
TCStringDecodeExceptionInstant getLastUpdated()
TCStringDecodeExceptionint getCmpId()
TCStringDecodeExceptionint getCmpVersion()
TCStringDecodeExceptionint getConsentScreen()
TCStringDecodeExceptionString getConsentLanguage()
TCStringDecodeExceptionint getVendorListVersion()
TCStringDecodeExceptionIntIterable getPurposesConsent()
TCStringDecodeExceptionIntIterable getVendorConsent()
TCStringDecodeExceptionboolean getDefaultVendorConsent()
TCStringDecodeExceptionint getTcfPolicyVersion()
TCStringDecodeExceptionboolean isServiceSpecific()
TCStringDecodeExceptionboolean getUseNonStandardStacks()
TCStringDecodeExceptionIntIterable getSpecialFeatureOptIns()
TCStringDecodeExceptionIntIterable getPurposesLITransparency()
TCStringDecodeExceptionboolean getPurposeOneTreatment()
TCStringDecodeExceptionString getPublisherCC()
TCStringDecodeExceptionIntIterable getVendorLegitimateInterest()
TCStringDecodeExceptionList<PublisherRestriction> getPublisherRestrictions()
TCStringDecodeExceptionIntIterable getAllowedVendors()
TCStringDecodeExceptionIntIterable getDisclosedVendors()
TCStringDecodeExceptionIntIterable getPubPurposesConsent()
TCStringDecodeExceptionIntIterable getPubPurposesLITransparency()
TCStringDecodeExceptionIntIterable getCustomPurposesConsent()
TCStringDecodeExceptionIntIterable getCustomPurposesLITransparency()
TCStringDecodeExceptionCopyright © 2020. All rights reserved.