Class OptionStore

See PHP file inc/Assets.php.

Hierarchy (view full)

Constructors

constructor

Properties

addLinksToNavigationMenu affiliateLabelBehind? affiliateLabelDescription? affiliateLink? ageNoticeAgeLimit allBlockerCount allCookieCount allScannerResultExternalUrlsCount allScannerResultTemplatesCount allTcfVendorConfigurationCount bannerLessConsentShowOnPageIds bannerLinks bannerlessConsentChecks busyAddLinksToNavigationMenu busyCountryBypassUpdate busySettings checkSavingConsentViaRestApiEndpointWorkingHtml chunkFolder? chunks? chunksLanguageFolder? cloudReleaseInfo consentDuration consentsDeletedAt contexts cookieCounts cookieDuration cookiePolicyId countryBypassCountries countryBypassDbDownloadTime? countryBypassType? createdTagManagers crossDomains dashboardMigration dismissBannerlessConsentLegitimateServicesNotice dismissBannerlessConsentServicesWithoutVisualContentBlockerNotice dismissConfigProNotice dismissMigration dismissServiceDataProcessingInUnsafeCountriesNotice failedConsentDocumentationHandling fetchBannerLinks fetchCurrentRevision fetchSettings fetchedBannerLinks fomoCoupon forwardTo googleConsentModeNoticesHtml hidePageIds isAcceptAllForBots isAgeNotice isBannerActive isBannerLessConsent isBannerStickyLinksEnabled? isBlockerActive isConsentForwarding isCountryBypass? isDataProcessingInUnsafeCountries isGcm? isGcmCollectAdditionalDataViaUrlParameters? isGcmListPurposes? isGcmRedactAdsDataWithoutConsent? isGcmShowRecommandationsWithoutConsent? isListServicesNotice isRespectDoNotTrack isSaveIp isTcf navMenus needsRevisionRetrigger operatorContactAddress operatorContactEmail operatorContactFormId operatorContactPhone operatorCountry others publicCookieCount publicUrl? pureSlug pureSlugCamelCased restNamespace? restNonce? restPathObfuscateOffset? restQuery? restRecreateNonceEndpoint? restRoot? restUrl? rootStore servicesDataProcessingInUnsafeCountriesNoticeHtml servicesWithEmptyPrivacyPolicyNoticeHtml setCookiesViaManager setModalHintSeen slug tcfAcceptedTime? tcfGvlDownloadTime? tcfVendorConfigurationCounts? templateNeedsUpdate templateSuccessorsNoticeHtml templateUpdateNoticeHtml territorialLegalBasis textDomain updateCountryBypassDatabase updateCurrentRevision updateSettings version

Accessors

areSettingsFetched isOnlyRcbCookieCreated

Methods

setFromCurrentRevision setShowLicenseFormImmediate getPureSlug slugCamelCase

Constructors

constructor

Properties

addLinksToNavigationMenu

addLinksToNavigationMenu: ((id) => Promise<boolean>) = ...

Type declaration

    • (id): Promise<boolean>

    • Parameters

      • id: string

      Returns Promise<boolean>

Optional affiliateLabelBehind

affiliateLabelBehind?: string | false

Optional affiliateLabelDescription

affiliateLabelDescription?: string | false

Optional affiliateLink

affiliateLink?: string

ageNoticeAgeLimit

ageNoticeAgeLimit: "INHERIT" | "GDPR" | string & {
    h?: string;
}

allBlockerCount

allBlockerCount: number = 0

allCookieCount

allCookieCount: number = 0

allScannerResultExternalUrlsCount

allScannerResultExternalUrlsCount: number = 0

allScannerResultTemplatesCount

allScannerResultTemplatesCount: number = 0

allTcfVendorConfigurationCount

allTcfVendorConfigurationCount: number = 0

bannerLessConsentShowOnPageIds

bannerLessConsentShowOnPageIds: number[]

bannerLinks

bannerLinks: BannerLinkCollection

bannerlessConsentChecks

bannerlessConsentChecks: Record<"essential" | "legalBasisConsentWithoutVisualContentBlocker" | "legalBasisLegitimateInterest", {
    groupId: number;
    id: number;
    name: string;
}[]> = ...

busyAddLinksToNavigationMenu

busyAddLinksToNavigationMenu: boolean = false

busyCountryBypassUpdate

busyCountryBypassUpdate: boolean = false

busySettings

busySettings: boolean = false

checkSavingConsentViaRestApiEndpointWorkingHtml

checkSavingConsentViaRestApiEndpointWorkingHtml: string

Optional chunkFolder

chunkFolder?: string

Optional chunks

chunks?: Record<string, string[]>

Optional chunksLanguageFolder

chunksLanguageFolder?: string

cloudReleaseInfo

cloudReleaseInfo: Record<"blocker" | "service", {
    downloadTime: string;
    isPreReleaseEnabled: boolean;
    releaseId: number;
}> = ...

Type declaration

  • downloadTime: string
  • isPreReleaseEnabled: boolean
  • releaseId: number

consentDuration

consentDuration: number

consentsDeletedAt

consentsDeletedAt: string

contexts

contexts: Record<string, string> = ...

cookieCounts

cookieCounts: {
    draft: number;
    private: number;
    publish: number;
    [key: string]: number;
} = ...

Type declaration

  • [key: string]: number
  • draft: number
  • private: number
  • publish: number

cookieDuration

cookieDuration: number

cookiePolicyId

cookiePolicyId: number

countryBypassCountries

countryBypassCountries: string[] = []

Optional countryBypassDbDownloadTime

countryBypassDbDownloadTime?: string

Optional countryBypassType

countryBypassType?: "essentials" | "all"

createdTagManagers

createdTagManagers: Record<"gtm" | "mtm", number[]> = ...

crossDomains

crossDomains: string

dashboardMigration

dashboardMigration: DashboardTileMigration

dismissBannerlessConsentLegitimateServicesNotice

dismissBannerlessConsentLegitimateServicesNotice: (() => Promise<void>) = ...

Type declaration

    • (): Promise<void>

    • Returns Promise<void>

dismissBannerlessConsentServicesWithoutVisualContentBlockerNotice

dismissBannerlessConsentServicesWithoutVisualContentBlockerNotice: (() => Promise<void>) = ...

Type declaration

    • (): Promise<void>

    • Returns Promise<void>

dismissConfigProNotice

dismissConfigProNotice: (() => Promise<void>) = ...

Type declaration

    • (): Promise<void>

    • Returns Promise<void>

dismissMigration

dismissMigration: (() => Promise<void>) = ...

Type declaration

    • (): Promise<void>

    • Returns Promise<void>

dismissServiceDataProcessingInUnsafeCountriesNotice

dismissServiceDataProcessingInUnsafeCountriesNotice: (() => Promise<void>) = ...

Type declaration

    • (): Promise<void>

    • Returns Promise<void>

failedConsentDocumentationHandling

failedConsentDocumentationHandling: "optimistic" | "essentials"

fetchBannerLinks

fetchBannerLinks: (() => Promise<void>) = ...

Type declaration

    • (): Promise<void>

    • Returns Promise<void>

fetchCurrentRevision

fetchCurrentRevision: (() => Promise<void>) = ...

Type declaration

    • (): Promise<void>

    • Returns Promise<void>

fetchSettings

fetchSettings: ((setFrom?) => Promise<void>) = ...

Type declaration

fetchedBannerLinks

fetchedBannerLinks: boolean = false

fomoCoupon

fomoCoupon: {
    coupon: string;
    validUntil: string;
    valueInPercent: number;
}

Type declaration

  • coupon: string
  • validUntil: string
  • valueInPercent: number

forwardTo

forwardTo: string[] = []

googleConsentModeNoticesHtml

googleConsentModeNoticesHtml: string[] = []

hidePageIds

hidePageIds: number[] = []

isAcceptAllForBots

isAcceptAllForBots: boolean

isAgeNotice

isAgeNotice: boolean

isBannerActive

isBannerActive: boolean = false

isBannerLessConsent

isBannerLessConsent: boolean

Optional isBannerStickyLinksEnabled

isBannerStickyLinksEnabled?: boolean = false

isBlockerActive

isBlockerActive: boolean = false

isConsentForwarding

isConsentForwarding: boolean

Optional isCountryBypass

isCountryBypass?: boolean

isDataProcessingInUnsafeCountries

isDataProcessingInUnsafeCountries: boolean

Optional isGcm

isGcm?: boolean = false

Optional isGcmCollectAdditionalDataViaUrlParameters

isGcmCollectAdditionalDataViaUrlParameters?: boolean = false

Optional isGcmListPurposes

isGcmListPurposes?: boolean = true

Optional isGcmRedactAdsDataWithoutConsent

isGcmRedactAdsDataWithoutConsent?: boolean = true

Optional isGcmShowRecommandationsWithoutConsent

isGcmShowRecommandationsWithoutConsent?: boolean = false

isListServicesNotice

isListServicesNotice: boolean

isRespectDoNotTrack

isRespectDoNotTrack: boolean

isSaveIp

isSaveIp: boolean

isTcf

isTcf: boolean = false

navMenus

navMenus: ({
    applied: boolean;
    edit_url: string;
    id: string;
    languages: {
        code: string;
        language: string;
        location: string;
    }[];
    locations: Record<string, string>;
    name: string;
    term_id: number;
    type: "legacy_nav";
} | {
    applied: boolean;
    edit_url: string;
    id: string;
    languages: {
        code: string;
        language: string;
        location: string;
    }[];
    name: string;
    post_id: number;
    type: "nav_menu";
})[] = []

needsRevisionRetrigger

needsRevisionRetrigger: boolean = false

operatorContactAddress

operatorContactAddress: string

operatorContactEmail

operatorContactEmail: string

operatorContactFormId

operatorContactFormId: number

operatorContactPhone

operatorContactPhone: string

operatorCountry

operatorCountry: string

others

others: OtherOptions

publicCookieCount

publicCookieCount: number = 0

Optional publicUrl

publicUrl?: string

Readonly pureSlug

pureSlug: string

Readonly pureSlugCamelCased

pureSlugCamelCased: string

Optional restNamespace

restNamespace?: string

Optional restNonce

restNonce?: string

Optional restPathObfuscateOffset

restPathObfuscateOffset?: string

Optional restQuery

restQuery?: object

Optional restRecreateNonceEndpoint

restRecreateNonceEndpoint?: string

Optional restRoot

restRoot?: string

Optional restUrl

restUrl?: string

Readonly rootStore

rootStore: RootStore

servicesDataProcessingInUnsafeCountriesNoticeHtml

servicesDataProcessingInUnsafeCountriesNoticeHtml: string = ""

servicesWithEmptyPrivacyPolicyNoticeHtml

servicesWithEmptyPrivacyPolicyNoticeHtml: string = ""

setCookiesViaManager

setCookiesViaManager: ServiceTagManager

setModalHintSeen

setModalHintSeen: ((identifier) => Promise<void>) = ...

Type declaration

    • (identifier): Promise<void>

    • Parameters

      • identifier: ConfigHintTextIdentifier

      Returns Promise<void>

slug

slug: string

Optional tcfAcceptedTime

tcfAcceptedTime?: string

Optional tcfGvlDownloadTime

tcfGvlDownloadTime?: string

Optional tcfVendorConfigurationCounts

tcfVendorConfigurationCounts?: {
    draft: number;
    private: number;
    publish: number;
    [key: string]: number;
}

Type declaration

  • [key: string]: number
  • draft: number
  • private: number
  • publish: number

templateNeedsUpdate

templateNeedsUpdate: {
    post_id: number;
    post_template_identifier: string;
    post_template_version: number;
    post_title: string;
    post_type: string;
    post_version_meta_id: number;
    should: number;
}[] = []

Type declaration

  • post_id: number
  • post_template_identifier: string
  • post_template_version: number
  • post_title: string
  • post_type: string
  • post_version_meta_id: number
  • should: number

templateSuccessorsNoticeHtml

templateSuccessorsNoticeHtml: string

templateUpdateNoticeHtml

templateUpdateNoticeHtml: string

territorialLegalBasis

territorialLegalBasis: TerritorialLegalBasis[]

textDomain

textDomain: string

updateCountryBypassDatabase

updateCountryBypassDatabase: (() => Promise<void>) = ...

Type declaration

    • (): Promise<void>

    • Returns Promise<void>

updateCurrentRevision

updateCurrentRevision: ((data) => Promise<void>) = ...

Type declaration

updateSettings

updateSettings: ((update, bannerLinks?) => Promise<void>) = ...

Type declaration

    • (update, bannerLinks?): Promise<void>

    • Parameters

      • update: Partial<OptionStore>
      • Optional bannerLinks: FormSettingsValuePropsNavItem[]

      Returns Promise<void>

version

version: string

Accessors

areSettingsFetched

  • get areSettingsFetched(): boolean

  • Returns boolean

isOnlyRcbCookieCreated

  • get isOnlyRcbCookieCreated(): boolean

  • Ignore real-cookie-banner cookie as it is hidden when no other cookie is created.

    Returns boolean

Methods

setFromCurrentRevision

  • setFromCurrentRevision(__namedParameters): void

  • Parameters

    Returns void

setShowLicenseFormImmediate

  • setShowLicenseFormImmediate(state, isLicensed): void

  • Parameters

    • state: boolean
    • isLicensed: boolean

    Returns void

Static getPureSlug

  • getPureSlug(slug, camelCase?): string

  • Get the slug from the current process (webpack) instead of the PHP plugin output. For some cases you need to use that.

    Parameters

    • slug: string
    • camelCase: boolean = false

    Returns string

Static slugCamelCase

  • slugCamelCase(slug): string

  • Convert a slug like "my-plugin" to "myPlugin". This can be useful for library naming (window[""] is bad because the hyphens).

    Parameters

    • slug: string

    Returns string

Settings

Member Visibility

Theme

On This Page

constructoraddLinksToNavigationMenuaffiliateLabelBehindaffiliateLabelDescriptionaffiliateLinkageNoticeAgeLimitallBlockerCountallCookieCountallScannerResultExternalUrlsCountallScannerResultTemplatesCountallTcfVendorConfigurationCountbannerLessConsentShowOnPageIdsbannerLinksbannerlessConsentChecksbusyAddLinksToNavigationMenubusyCountryBypassUpdatebusySettingscheckSavingConsentViaRestApiEndpointWorkingHtmlchunkFolderchunkschunksLanguageFoldercloudReleaseInfoconsentDurationconsentsDeletedAtcontextscookieCountscookieDurationcookiePolicyIdcountryBypassCountriescountryBypassDbDownloadTimecountryBypassTypecreatedTagManagerscrossDomainsdashboardMigrationdismissBannerlessConsentLegitimateServicesNoticedismissBannerlessConsentServicesWithoutVisualContentBlockerNoticedismissConfigProNoticedismissMigrationdismissServiceDataProcessingInUnsafeCountriesNoticefailedConsentDocumentationHandlingfetchBannerLinksfetchCurrentRevisionfetchSettingsfetchedBannerLinksfomoCouponforwardTogoogleConsentModeNoticesHtmlhidePageIdsisAcceptAllForBotsisAgeNoticeisBannerActiveisBannerLessConsentisBannerStickyLinksEnabledisBlockerActiveisConsentForwardingisCountryBypassisDataProcessingInUnsafeCountriesisGcmisGcmCollectAdditionalDataViaUrlParametersisGcmListPurposesisGcmRedactAdsDataWithoutConsentisGcmShowRecommandationsWithoutConsentisListServicesNoticeisRespectDoNotTrackisSaveIpisTcfnavMenusneedsRevisionRetriggeroperatorContactAddressoperatorContactEmailoperatorContactFormIdoperatorContactPhoneoperatorCountryotherspublicCookieCountpublicUrlpureSlugpureSlugCamelCasedrestNamespacerestNoncerestPathObfuscateOffsetrestQueryrestRecreateNonceEndpointrestRootrestUrlrootStoreservicesDataProcessingInUnsafeCountriesNoticeHtmlservicesWithEmptyPrivacyPolicyNoticeHtmlsetCookiesViaManagersetModalHintSeenslugtcfAcceptedTimetcfGvlDownloadTimetcfVendorConfigurationCountstemplateNeedsUpdatetemplateSuccessorsNoticeHtmltemplateUpdateNoticeHtmlterritorialLegalBasistextDomainupdateCountryBypassDatabaseupdateCurrentRevisionupdateSettingsversionareSettingsFetchedisOnlyRcbCookieCreatedsetFromCurrentRevisionsetShowLicenseFormImmediategetPureSlugslugCamelCase