Class CookieConsentManager<Transaction>

constructor

• new CookieConsentManager<
      Transaction extends
          Partial<
              {
                  buttonClicked: ClickableButtonsNamed;
                  createdClientTime: string;
                  decision: "all"
                  | "essentials"
                  | DecisionConsentGroups;
                  gcmConsent: EServiceTemplateGoogleConsentModeTypes[];
                  revision: string;
                  tcfString: string;
              },
          > = any,
  >(
      options: Omit<
          CookieConsentManagerOptions<Transaction>,
          "tcfCookieName" | "gcmCookieName",
      >,
  ): CookieConsentManager<Transaction>

  Type Parameters

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

  Parameters

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

  Returns CookieConsentManager<Transaction>

StaticBROADCAST_SIGNAL_APPLY_COOKIES

applyCookies

• applyCookies(
      options: Pick<
          Parameters<typeof apply>[0],
          "type" | "triggeredByOtherTab",
      >,
  ): Promise<void>

  Parameters

  • options: Pick<Parameters<typeof apply>[0], "type" | "triggeredByOtherTab">

  Returns Promise<void>

getConsentQueue

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

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

getConsentQueueName

• getConsentQueueName(lock?: boolean): string

  Parameters

  • lock: boolean = false

  Returns string

getDefaultDecision

• getDefaultDecision(respectLegitimateInterests?: boolean): DecisionConsentGroups

  Parameters

  • respectLegitimateInterests: boolean = true

  Returns DecisionConsentGroups

getOption

• getOption<K extends keyof CookieConsentManagerOptions<any>>(
      name: K,
  ): 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?: boolean): false | Decision

  Parameters

  • OptionalonlyUptoDate: boolean

  Returns false | Decision

isConsentQueueLocked

• isConsentQueueLocked(set?: boolean): boolean

  Parameters

  • Optionalset: boolean

  Returns boolean

persistConsent

• persistConsent(transaction: 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: Partial<
          {
              buttonClicked: ClickableButtonsNamed;
              createdClientTime: string;
              decision: "all"
              | "essentials"
              | DecisionConsentGroups;
              gcmConsent: EServiceTemplateGoogleConsentModeTypes[];
              revision: string;
              tcfString: string;
          },
      >[],
  ): void

  Parameters

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

  Returns void