Options
All
  • Public
  • Public/Protected
  • All
Menu

Class TCFOptions

Hierarchy

  • TCFOptions

Index

Constructors

Properties

Methods

Constructors

constructor

  • new TCFOptions(legacySettings: LegacySettings, dataTransferSettings: DataTransferSettings): TCFOptions

  • Parameters

    • legacySettings: LegacySettings
    • dataTransferSettings: DataTransferSettings

    Returns TCFOptions

Properties

changedPurposes

changedPurposes: TCFChangedPurposes

cmpId

cmpId: number

cmpVersion

cmpVersion: number

consensuScriptPath

consensuScriptPath: string

consensuSubdomain

consensuSubdomain: string

disabledSpecialFeatures

disabledSpecialFeatures: number[]

gdprApplies

gdprApplies: boolean

hideLegitimateInterestToggles

hideLegitimateInterestToggles: boolean

isServiceSpecific

isServiceSpecific: boolean

publisherCountryCode

publisherCountryCode: string

purposeOneTreatment

purposeOneTreatment: boolean

resurfaceOptions

resurfaceOptions: ResurfaceOptions

stackIds

stackIds: number[]

tcfv2HistoryDisabled

tcfv2HistoryDisabled: boolean

useGranularChoice

useGranularChoice: boolean

vendorIds

vendorIds: number[]

Methods

acceptAllDisclosed

  • Parameters

    Returns Promise<void>

areAllPurposesAccepted

  • areAllPurposesAccepted(): boolean

  • Returns boolean

areAllVendorsAccepted

  • areAllVendorsAccepted(): boolean

  • Returns boolean

changeLanguage

  • changeLanguage(language: string): Promise<void>

  • Parameters

    • language: string

    Returns Promise<void>

denyAllDisclosed

  • Parameters

    Returns Promise<void>

getGdprApplies

  • getGdprApplies(): Promise<boolean>

  • If GDPR applies is false, then GDPR applies is set to true in TC String. If GDPR applies is true and user is inside EU, set it to true in TC String. If GDPR applies is true and user is outside EU, set it to false in TC String. (refs EUD-487)

    Returns Promise<boolean>

getSelectedVendorsIncludeNonDisclosed

  • getSelectedVendorsIncludeNonDisclosed(): boolean

  • Returns boolean

getTCFData

  • Returns TCFData

getTCString

  • getTCString(): string

  • Returns string

init

  • init(): Promise<void>

  • Returns Promise<void>

resetTcf

  • resetTcf(): void

  • Returns void

setUIAsClosed

  • setUIAsClosed(): Promise<void>

  • Returns Promise<void>

setUIAsOpen

  • setUIAsOpen(): Promise<void>

  • Returns Promise<void>

shouldResurfaceUI

  • shouldResurfaceUI(): boolean

  • Returns boolean

updateChoices

updateControllerId

  • updateControllerId(value: string): void

  • Parameters

    • value: string

    Returns void