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

Consent Management Platform API

This is the only class that the CMP should create and interface with to set data for commands to utilize.

Hierarchy

  • CmpApi

Index

Constructors

Accessors

Methods

Constructors

constructor

Accessors

tcModel

tcModel:

Sets the TCModel the commands will use to facilitate page requests

uiVisible

uiVisible:

Sets whether or not the CMP is going to show the CMP UI to the user.

Methods

disable

  • disable(): void

  • Disables the CmpApi from serving anything but ping and custom commands Cannot be undone

    Returns void

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