@iabtcf/cmpapi - API Documentation
Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

  • new TCData(vendorIds?: number[]): TCData

  • Constructor to create a TCData object from a TCModel

    Parameters

    • Optional vendorIds: number[]

      if not undefined, will be used to filter vendor ids

    Returns TCData

Properties

cmpId

cmpId: number = CmpApiModel.cmpId

cmpStatus

cmpStatus: CmpStatus

cmpVersion

cmpVersion: number = CmpApiModel.cmpVersion

eventStatus

eventStatus: EventStatus

gdprApplies

gdprApplies: boolean = CmpApiModel.gdprApplies

isServiceSpecific

isServiceSpecific: Booleany

outOfBand

outOfBand: object

Type declaration

publisher

publisher: object

Type declaration

publisherCC

publisherCC: string

purpose

purpose: object

Type declaration

purposeOneTreatment

purposeOneTreatment: Booleany

specialFeatureOptins

specialFeatureOptins: BooleanVector | string

tcString

tcString: string

tcfPolicyVersion

tcfPolicyVersion: number = CmpApiModel.tcfPolicyVersion

useNonStandardStacks

useNonStandardStacks: Booleany

vendor

vendor: object

Type declaration

Methods

Protected createRestrictions

  • createRestrictions(purpRestrictions: PurposeRestrictionVector): Restrictions

  • Creates a restrictions object given a PurposeRestrictionVector

    Parameters

    • purpRestrictions: PurposeRestrictionVector

    Returns Restrictions

Protected createVectorField

  • createVectorField(vector: Vector, ids?: number[]): BooleanVector | string

  • Creates a string bit field with a value for each id where each value is '1' if its id is in the passed in vector Can be overwritten to return a string

    Parameters

    • vector: Vector
    • Optional ids: number[]

      filter

    Returns BooleanVector | string

Legend

  • Module
  • Object literal
  • Variable
  • Function
  • Function with type parameter
  • Index signature
  • Type alias
  • Enumeration
  • Enumeration member
  • Property
  • Method
  • Interface
  • Interface with type parameter
  • Constructor
  • Property
  • Method
  • Index signature
  • Class
  • Class with type parameter
  • Constructor
  • Property
  • Method
  • Accessor
  • Index signature
  • Inherited constructor
  • Inherited property
  • Inherited method
  • Inherited accessor
  • Protected property
  • Protected method
  • Protected accessor
  • Private property
  • Private method
  • Private accessor
  • Static property
  • Static method

Generated using TypeDoc