Options
All
  • Public
  • Public/Protected
  • All
Menu

@usercentrics/cmp-browser-sdk - v1.13.0

Index

Namespaces

Enumerations

Classes

Interfaces

Type aliases

Functions

Type aliases

GlobalCallback

GlobalCallback: (data: GlobalCallbackData | null, success: boolean) => void

Type declaration

GlobalFunction

GlobalFunction: (command: API_COMMANDS, version: number, callback: GlobalCallback) => void

Type declaration

LogoPosition

LogoPosition: "center" | "left" | "right"

TCFFeature

TCFFeature: BasePurpose

A TCF feature that needs to be disclosed to the end-user.

TCFSpecialPurpose

TCFSpecialPurpose: BasePurpose

A TCF special purpose that needs to be disclosed to the end-user.

TCFUserDecisionOnSpecialFeature

TCFUserDecisionOnSpecialFeature: BaseTCFUserDecision

A user's consent decision for a single special feature

TCFVendorRestrictionType

TCFVendorRestrictionType: RestrictionType

Functions

Const addFrame

  • addFrame(): void

  • Returns void

Const convertCcpaStringToBoolean

  • convertCcpaStringToBoolean(ccpaString: string): boolean

  • Parameters

    • ccpaString: string

    Returns boolean

Const createCcpaString

  • createCcpaString(isOptedOut: boolean, isNoticeGiven: STRING_CHARACTER, iabAgreementExists: boolean): string

  • Parameters

    • isOptedOut: boolean
    • isNoticeGiven: STRING_CHARACTER
    • iabAgreementExists: boolean

    Returns string

Const getCcpaStoredDaysAgo

  • getCcpaStoredDaysAgo(): number

  • Returns number

Const getOptOutStatus

  • getOptOutStatus(): boolean

  • Returns boolean

Const getServices

  • getServices(legacyCategory: LegacyCategory, legacyServices: LegacyService[], legacyHashServices: LegacyHashService[], legalBasisTranslation: LegalBasisTranslation | null): Service[]

  • Parameters

    • legacyCategory: LegacyCategory
    • legacyServices: LegacyService[]
    • legacyHashServices: LegacyHashService[]
    • legalBasisTranslation: LegalBasisTranslation | null

    Returns Service[]

Const handleUspApiMessage

  • handleUspApiMessage(event: MessageEvent): void

  • Parameters

    • event: MessageEvent

    Returns void

Const mapLogoPosition

  • mapLogoPosition(legacyPosition?: FIRST_LAYER_LOGO_POSITION): LogoPosition

  • Parameters

    • Optional legacyPosition: FIRST_LAYER_LOGO_POSITION

    Returns LogoPosition

Const setPublicApi

  • setPublicApi(): void

  • Returns void