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

Ping response builder

Hierarchy

Index

Constructors

Properties

Constructors

constructor

Properties

apiVersion

apiVersion: number = CmpApiModel.apiVersion

version of the CMP API that is supported; e.g. “2”

cmpId

cmpId: number = CmpApiModel.cmpId

cmpLoaded

cmpLoaded: boolean = true

true - CMP main script is loaded false - still running stub

cmpStatus

cmpStatus: CmpStatus = CmpApiModel.cmpStatus

see Ping Status Codes in following table

cmpVersion

cmpVersion: number = CmpApiModel.cmpVersion

displayStatus

displayStatus: DisplayStatus = CmpApiModel.displayStatus

see Ping Status Codes in following table

gdprApplies

gdprApplies: boolean = CmpApiModel.gdprApplies

gvlVersion

gvlVersion: number

Version of the GVL currently loaded by the CMP undefined if still the stub

tcfPolicyVersion

tcfPolicyVersion: number = CmpApiModel.tcfPolicyVersion

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