Package com.iab.gdpr.consent.implementation.v1

Class VendorConsentBuilder

  • public class VendorConsentBuilder
extends Object
    Builder for version 1 of vendor consent

    • Constructor Detail

      • VendorConsentBuilder

        public VendorConsentBuilder()

    • Method Detail

      • withConsentRecordCreatedOn

        public VendorConsentBuilder withConsentRecordCreatedOn​(Instant consentRecordCreated)
        With creation date
        Parameters:
        consentRecordCreated - Epoch deciseconds when record was created
        Returns:
        builder

      • withConsentRecordLastUpdatedOn

        public VendorConsentBuilder withConsentRecordLastUpdatedOn​(Instant consentRecordLastUpdated)
        With update date
        Parameters:
        consentRecordLastUpdated - Epoch deciseconds when consent string was last updated
        Returns:
        builder

      • withCmpID

        public VendorConsentBuilder withCmpID​(int cmpID)
        With CMP id
        Parameters:
        cmpID - Consent Manager Provider ID that last updated the consent string
        Returns:
        builder

      • withCmpVersion

        public VendorConsentBuilder withCmpVersion​(int cmpVersion)
        With CMP version
        Parameters:
        cmpVersion - Consent Manager Provider version
        Returns:
        builder

      • withConsentScreenID

        public VendorConsentBuilder withConsentScreenID​(int consentScreenID)
        With consent screen ID
        Parameters:
        consentScreenID - Screen number in the CMP where consent was given
        Returns:
        builder

      • withConsentLanguage

        public VendorConsentBuilder withConsentLanguage​(String consentLanguage)
        With consent language
        Parameters:
        consentLanguage - Two-letter ISO639-1 language code that CMP asked for consent in
        Returns:
        builder

      • withVendorListVersion

        public VendorConsentBuilder withVendorListVersion​(int vendorListVersion)
        With vendor list version
        Parameters:
        vendorListVersion - Version of vendor list used in most recent consent string update
        Returns:
        builder

      • withAllowedPurposeIds

        public VendorConsentBuilder withAllowedPurposeIds​(Set<Integer> allowedPurposeIds)
        With allowed purpose IDs
        Parameters:
        allowedPurposeIds - set of allowed purposes
        Returns:
        builder

      • withAllowedPurposes

        public VendorConsentBuilder withAllowedPurposes​(Set<Purpose> allowedPurposes)
        With allowed purposes
        Parameters:
        allowedPurposes - set of allowed purposes
        Returns:
        builder

      • withMaxVendorId

        public VendorConsentBuilder withMaxVendorId​(int maxVendorId)
        With max vendor ID
        Parameters:
        maxVendorId - The maximum VendorId for which consent values are given.
        Returns:
        builder

      • withVendorEncodingType

        public VendorConsentBuilder withVendorEncodingType​(int vendorEncodingType)
        With vendor encoding type
        Parameters:
        vendorEncodingType - 0=BitField 1=Range
        Returns:
        builder

      • withBitField

        public VendorConsentBuilder withBitField​(Set<Integer> bitFieldEntries)
        With bit field entries
        Parameters:
        bitFieldEntries - set of VendorIds for which the vendors have consent
        Returns:
        builder

      • withRangeEntries

        public VendorConsentBuilder withRangeEntries​(List<RangeEntry> rangeEntries)
        With range entries
        Parameters:
        rangeEntries - List of VendorIds or a range of VendorIds for which the vendors have consent
        Returns:
        builder

      • withDefaultConsent

        public VendorConsentBuilder withDefaultConsent​(boolean defaultConsent)
        With default consent
        Parameters:
        defaultConsent - Default consent for VendorIds not covered by a RangeEntry. 0=No Consent 1=Consent
        Returns:
        builder