core/bootstrap/cookie-banner/cookie-banner.service.ts
This service is handling the cookie banner and cookie preferences related logic.
Properties |
|
Methods |
constructor(options: OptionsService)
|
||||||
|
Parameters :
|
| getCookieBannerSettings |
getCookieBannerSettings()
|
|
Returns Cookie banner configuration.
Returns :
Partial<CookieBannerSettings>
Return an object with cookie banner configuration defined in application options. |
| getCookieDescription | ||||||||
getCookieDescription(cookieType: "required" | "functional" | "marketing")
|
||||||||
|
Description of cookies.
Parameters :
Returns :
string
The default cookie description, if not explicitly defined in application options. |
| getCookiePreferencesConfig |
getCookiePreferencesConfig()
|
|
Returns Cookie preferences configuration.
Returns :
CookiePreferences
Return an object with cookie preferences configuration defined in application options. |
| getUserCookiePreferences |
getUserCookiePreferences()
|
|
Gets the cookie preferences configuration from local storage.
Returns :
CookiePreferences
Object with cookie preferences configuration. |
| isConfigCookiePreferencesDefined |
isConfigCookiePreferencesDefined()
|
|
Verifies that cookie preferences configuration is defined in the application options.
Returns :
boolean
Returns if the cookie preferences configuration is defined. |
| isFunctionalCookieEnabled |
isFunctionalCookieEnabled()
|
|
Verifies that functional cookies are enabled.
Returns :
boolean
True when functional cookies are enabled. |
| setCookies | ||||||||||||
setCookies(cookiePreferences: CookiePreferences, policyVersion?: string)
|
||||||||||||
|
Converts the cookie preferences to boolean. Sets the cookie preferences configuration in local storage.
Parameters :
Returns :
void
|
| shouldShowCookieBanner |
shouldShowCookieBanner()
|
|
Verifies that cookie banner should be shown.
Returns :
boolean
Returns if the cookie banner should be shown. |
| transformCookiePreferencesListToCookiePreferences | ||||||||
transformCookiePreferencesListToCookiePreferences(cookiePreferencesList: Cookie[])
|
||||||||
|
Transforms an array of cookie preferences objects to cookie preferences configuration object.
Parameters :
Returns :
CookiePreferences
An object with cookie preferences configuration. |
| transformCookiePreferencesToList | ||||||
transformCookiePreferencesToList(cookiePreferences: CookiePreferences)
|
||||||
|
Transforms cookie preferences configuration object to an array of cookie preferences objects. Each object in returned array contains cookie 'name', 'value' and 'isReadonly' property.
Parameters :
Returns :
Cookie[]
Array shows if the cookie is Readonly. |
| Readonly COOKIE_BANNER |
Type : string
|
Default value : 'cookieBanner'
|
| Readonly COOKIE_PREFERENCES_CONFIG |
Type : string
|
Default value : 'cookiePreferences'
|
| cookieDescriptions |
Type : object
|
Default value : {
required: gettext(
"These cookies are required to enable core site functionality. They perform a task or operation without which a site's functionality would not be possible."
),
functional: gettext(
'These cookies are used to support you during your first steps with the product, to deliver content tailored to your needs, and to collect usage statistics.'
),
marketing: gettext('These cookies are used to target advertising to a user.')
}
|
| Readonly IS_PREVIEW |
Type : string
|
Default value : 'preview'
|
| isCookieBannerShowed$ |
Type : Subject<boolean>
|
Default value : new Subject()
|
| Readonly PREVIEW_COOKIE_BANNER |
Type : string
|
Default value : 'previewCookieBanner'
|
| Readonly STORAGE_KEY |
Type : string
|
Default value : 'acceptCookieNotice'
|