Documentation Index

Fetch the complete documentation index at: https://usercentrics.document360.io/llms.txt

Use this file to discover all available pages before exploring further.

Welcome to our new beta documentation experience! Let us know what you think below, under "Was this article helpful?" 👍 👎

Interfaces

Prev Next

TCFDecisions

/** A user's consent decision on all TCF options */
interface TCFDecisions {
  /** A user's consent decision on TCF purposes */
  purposes?: TCFUserDecisionOnPurpose[];
  /** A user's consent decision on TCF special features */
  specialFeatures?: TCFUserDecisionOnSpecialFeature[];
  /** A user's consent decision on TCF vendors */
  vendors?: TCFUserDecisionOnVendor[];
}

BaseTCFUserDecision

interface BaseTCFUserDecision {
  /** Indicates if the user gave consent (true) or denied consent (false) */
  consent?: boolean;
  /** The id of the purpose/vendor the consent decision belongs to */
  id: number;
}

TCFUserDecisionOnPurpose

/** A user's consent decision for a single purpose */
interface TCFUserDecisionOnPurpose extends BaseTCFUserDecision {
  /** Indicates if the user gave legitimate interest consent (true) or denied consent (false) */
  legitimateInterestConsent?: boolean;
}

TCFUserDecisionOnSpecialFeature

/** A user's consent decision for a single special feature */
interface TCFUserDecisionOnSpecialFeature extends BaseTCFUserDecision {
  /** pasisng consent is compulsory */
  consent: boolean;
}