Class CookieConsentManager<Transaction>

constructor

• new CookieConsentManager<Transaction>(options): CookieConsentManager<Transaction>

• Type Parameters

  • Transaction extends Partial<{
        createdClientTime: string;
        decision: "essentials" | "all" | DecisionConsentGroups;
        gcmConsent: EServiceTemplateGoogleConsentModeTypes[];
        revision: string;
        tcfString: string;
    }> = any

  Parameters

  • options: Omit<CookieConsentManagerOptions<Transaction>, "tcfCookieName" | "gcmCookieName">

  Returns CookieConsentManager<Transaction>

Static BROADCAST_SIGNAL_APPLY_COOKIES

broadcastChannel

• get broadcastChannel(): BroadcastChannel

• A global broadcast channel for this cookie consent management.

  Returns BroadcastChannel

applyCookies

• applyCookies(options, broadcast?): Promise<void>

• Parameters

  • options: Pick<{
        type: "essentials" | "all" | "consent";
    } & Pick<CookieConsentManagerOptions, "isGcm" | "setCookiesViaManager" | "groups" | "decisionCookieName"> & ApplyOptInOptions, "type">

  • broadcast: boolean = true

  Returns Promise<void>

getConsentQueue

• getConsentQueue(): Partial<{
      createdClientTime: string;
      decision: "essentials" | "all" | DecisionConsentGroups;
      gcmConsent: EServiceTemplateGoogleConsentModeTypes[];
      revision: string;
      tcfString: string;
  }>[]

• Returns Partial<{
      createdClientTime: string;
      decision: "essentials" | "all" | DecisionConsentGroups;
      gcmConsent: EServiceTemplateGoogleConsentModeTypes[];
      revision: string;
      tcfString: string;
  }>[]

getConsentQueueName

• getConsentQueueName(lock?): string

• Parameters

  • lock: boolean = false

  Returns string

getDefaultDecision

• getDefaultDecision(respectLegitimateInterests?): DecisionConsentGroups

• Parameters

  • respectLegitimateInterests: boolean = true

  Returns DecisionConsentGroups

getOption

• getOption<K>(name): CookieConsentManagerOptions<Transaction>[K]

• Type Parameters

  • K extends keyof CookieConsentManagerOptions<any>

  Parameters

  • name: K

  Returns CookieConsentManagerOptions<Transaction>[K]

getOptions

• getOptions(): CookieConsentManagerOptions<Transaction>

• Returns CookieConsentManagerOptions<Transaction>

getUserDecision

• getUserDecision(onlyUptoDate?): false | Decision

• Parameters

  • Optional onlyUptoDate: boolean

  Returns false | Decision

isConsentQueueLocked

• isConsentQueueLocked(set?): boolean

• Parameters

  • Optional set: boolean

  Returns boolean

persistConsent

• persistConsent(transaction): Promise<void>

• If you have passed a persistConsent as option to the manager constructor, you can use this method. This method wraps your passed callback and if an error occurs, it accordingly handles the error and pushes the transaction into a queue. The queue has a lifecycle to get retried at a later stage when e.g. your server is available again.

  Parameters

  • transaction: Transaction

  Returns Promise<void>

setConsentQueue

• setConsentQueue(queue): void

• Parameters

  • queue: Partial<{
        createdClientTime: string;
        decision: "essentials" | "all" | DecisionConsentGroups;
        gcmConsent: EServiceTemplateGoogleConsentModeTypes[];
        revision: string;
        tcfString: string;
    }>[]

  Returns void