Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface TCFPurpose

A TCF purpose that needs to be disclosed to the end-user and requires the end-user's consent and legitimate interest consent.

Hierarchy

  • BasePurpose
    • TCFPurpose

Index

Properties

consent

consent: boolean

A boolean value which indicates whether the user gave or refused consent for this TCF purpose. Defaults to false.

description

description: string

A user-friendly short description that needs to be disclosed to the end-user.

descriptionLegal

descriptionLegal: string

An official legal description that needs to be disclosed to the end-user.

id

id: number

The unique id as defined in the IAB global vendor list.

legitimateInterestConsent

legitimateInterestConsent: boolean

A boolean value which indicates whether the user gave or refused legitimate interest for this TCF purpose. Defaults to true.

name

name: string

The name as defined in the IAB global vendor list.

showLegitimateInterestToggle

showLegitimateInterestToggle: boolean

A boolean value which indicates whether the legitimate interest toggle needs to be displayed in the TCF second layer. Is always true except in certain cases for the purpose with id 1.