TCString | @iabtcf/core - API Documentation

Main class for encoding and decoding a TCF Transparency and Consent String

Hierarchy

TCString

Index

Methods

Methods

Static decode

decode(encodedTCString: string): TCModel

- Defined in src/TCString.ts:92
Decodes a string into a TCModel

Parameters
- encodedTCString: string
  
  base64url encoded Transparency and Consent String to decode
Returns TCModel
- Returns populated TCModel

Static encode

encode(tcModel: TCModel, isForSaving?: boolean): string

- Defined in src/TCString.ts:58
encodes a model into a TCString

Parameters
- tcModel: TCModel
  
  model to convert into encoded string
- Optional isForSaving: boolean
  
  = false - Defaults to false. Whether a TC String is meant for storage (true) or meant to be handed to AdTech through the tcfapi (true). This will modify which segments are handed back with the string.
Returns string
- base64url encoded Transparency and Consent String

Generated using TypeDoc