addConsent
The function can be used to store the consent to a Cookie Group and a Cookie in the visitor's Cookie.
Usage
window.BorlabsCookie.addConsent(cookieGroup, cookie);Arguments
| Argument | Type | Description |
|---|---|---|
| cookieGroup | String | ID of the Cookie Group, mandatory. |
| cookie | String | ID of the Cookie, optional. |
checkCookieConsent
Checks whether the visitor has given his consent for the Cookie transferred.
Usage
window.BorlabsCookie.checkCookieConsent(cookie);Arguments
| Argument | Type | Description |
|---|---|---|
| cookie | String | ID of the Cookie. |
checkCookieGroupConsent
Checks whether the visitor has given his consent for the Cookie Group transferred.
USAGE
window.BorlabsCookie.checkCookieGroupConsent(cookieGroup);Arguments
| Argument | Type | Description |
|---|---|---|
| cookieGroup | String | ID of the Cookie Group. |
deleteCookie
Deletes a cookie based on the cookie name. The imprecise parameter (true or false) can also be used to delete cookies whose name contains other individual characters, e.g. myCookie_x13cy14s.
Usage
window.BorlabsCookie.deleteCookie(cookieName, domain, imprecise);Arguments
| Argument | Type | Description |
|---|---|---|
| cookieName | String | The ID of the Cookie. |
| domain | String | The domain of the cookie. Cookies cannot be deleted from external hosts. If the value is null or false, the domain from the settings is used |
| imprecise | Bool | true: Deletes cookies in whose full name the value entered under cookieName occurs. Example: cookieName myCookie + imprecise true = Cookie myCookie_x13cy14s is deleted. |
getCookie
Returns the Borlabs Cookie Cookies object.
Usage
window.BorlabsCookie.getCookie();hideCookieBox
Hides the Cookie Box if it is currently displayed.
Usage
window.BorlabsCookie.hideCookieBox();openCookiePreference
Opens the Cookie Settings. The function can be called directly or linked to an event.
Usage
window.BorlabsCookie.openCookiePreference();
jQuery(".myButton").on("click", window.BorlabsCookie.openCookiePreference);optOutDone
When using the asynchronous opt-out, Borlabs Cookie must be notified that the opt-out has been completed after it has been executed.
Usage
window.BorlabsCookie.optOutDone(cookie);Arguments
| Argument | Type | Beschreibung |
|---|---|---|
| cookie | String | ID of the Cookie. |
removeConsent
Removes the consent to a Cookie Group or to a Cookie.
Usage
window.BorlabsCookie.removeConsent(cookieGroup, cookie);Arguments
| Argument | Type | Description |
|---|---|---|
| cookieGroup | String | ID of the Cookie Group, mandatory. |
| cookie | String | ID of the Cookie, optional. |
showCookieBox
Displays the Cookie Box. The function can be called directly or linked to an event.
Usage
window.BorlabsCookie.showCookieBox();
jQuery(".myButton").on("click", window.BorlabsCookie.showCookieBox);Argumentse
| Argument | Type | Description |
|---|---|---|
| withDelay | Bool | true: the call is delayed by 1 second. |
unblockContentId
Unblocks all contents of a Content Blocker.
Usage
window.BorlabsCookie.unblockContentId(contentBlockerId);Arguments
| Argument | Type | Description |
|---|---|---|
| contentBlockerId | String | ID of the Content Blocker. |