Class GdprManager

Manage multiple guard groups

Hierarchy

GdprManager

Implements

GdprGuardCollection
GdprRawInto<GdprManagerRaw>

Properties

bannerWasShown

bannerWasShown: boolean

Whether the banner has already been shown to the user

Readonly description

description: string

enabled

enabled: boolean

Whether the whole manager is enabled

Readonly events

events: GdprManagerEventHub

A hub to attach listeners to events triggered by this manager

Protected groups

groups: Map<string, GdprGuardGroup>

A mapping from group name to the corresponding group

Readonly name

name: string

required

required: boolean

Readonly storage

storage: GdprStorage

Methods

addGroup

addGroup(category: GdprGuardGroup): GdprManager

- Defined in node_modules/gdpr-guard/dist/GdprManager.d.ts:75
Add a group to this manager

memberof
GdprManager

Parameters
- category: GdprGuardGroup
  
  The group to add
Returns GdprManager

closeBanner

closeBanner(): void

- Defined in node_modules/gdpr-guard/dist/GdprManager.d.ts:56
Mark the GDPR banner as shown and trigger enable and disable events

Returns void

createGroup

createGroup(name: string, description?: string): GdprManager

- Defined in node_modules/gdpr-guard/dist/GdprManager.d.ts:68
Create and add a group to this manager

memberof
GdprManager

Parameters
- name: string
  
  The new group's name
- Optional description: string
Returns GdprManager

disable

disable(): GdprGuard

Implementation of GdprGuardCollection.disable
- Defined in node_modules/gdpr-guard/dist/GdprManager.d.ts:115
inheritdoc
override
memberof
GdprManager

Returns GdprGuard

disableForStorage

disableForStorage(type: GdprStorage): GdprGuard

Implementation of GdprGuardCollection.disableForStorage
- Defined in node_modules/gdpr-guard/dist/GdprManager.d.ts:140
inheritdoc
override
memberof
GdprManager

Parameters
- type: GdprStorage
Returns GdprGuard

enable

enable(): GdprGuard

Implementation of GdprGuardCollection.enable
- Defined in node_modules/gdpr-guard/dist/GdprManager.d.ts:109
inheritdoc
override
memberof
GdprManager

Returns GdprGuard

enableForStorage

enableForStorage(type: GdprStorage): GdprGuard

Implementation of GdprGuardCollection.enableForStorage
- Defined in node_modules/gdpr-guard/dist/GdprManager.d.ts:134
inheritdoc
override
memberof
GdprManager

Parameters
- type: GdprStorage
Returns GdprGuard

getGroup

getGroup(name: string): null | GdprGuardGroup

- Defined in node_modules/gdpr-guard/dist/GdprManager.d.ts:97
inheritdoc
memberof
GdprManager

Parameters
- name: string
Returns null | GdprGuardGroup

getGroups

getGroups(): GdprGuardGroup[]

- Defined in node_modules/gdpr-guard/dist/GdprManager.d.ts:170
Returns GdprGuardGroup[]

getGuard

getGuard(name: string): null | GdprGuard

Implementation of GdprGuardCollection.getGuard
- Defined in node_modules/gdpr-guard/dist/GdprManager.d.ts:87
inheritdoc
override
memberof
GdprManager

Parameters
- name: string
Returns null | GdprGuard

hasGroup

hasGroup(name: string): boolean

- Defined in node_modules/gdpr-guard/dist/GdprManager.d.ts:92
inheritdoc
memberof
GdprManager

Parameters
- name: string
Returns boolean

hasGuard

hasGuard(name: string): boolean

Implementation of GdprGuardCollection.hasGuard
- Defined in node_modules/gdpr-guard/dist/GdprManager.d.ts:81
inheritdoc
override
memberof
GdprManager

Parameters
- name: string
Returns boolean

isEnabled

isEnabled(name: string): boolean

Implementation of GdprGuardCollection.isEnabled
- Defined in node_modules/gdpr-guard/dist/GdprManager.d.ts:103
inheritdoc
override
memberof
GdprManager

Parameters
- name: string
Returns boolean

makeRequired

makeRequired(): GdprGuard

Implementation of GdprGuardCollection.makeRequired
- Defined in node_modules/gdpr-guard/dist/GdprManager.d.ts:128
Does nothing for a manager

inheritdoc
override
memberof
GdprManager

Returns GdprGuard

raw

raw(): GdprManagerRaw

Implementation of GdprRawInto.raw
- Defined in node_modules/gdpr-guard/dist/GdprManager.d.ts:153
Raw/simple representation of this guard

override
memberof
GdprManager

Returns GdprManagerRaw

resetAndShowBanner

resetAndShowBanner(): void

- Defined in node_modules/gdpr-guard/dist/GdprManager.d.ts:60
Reset the state of the GDPR banner and show it

Returns void

toggle

toggle(): GdprGuard

Implementation of GdprGuardCollection.toggle
- Defined in node_modules/gdpr-guard/dist/GdprManager.d.ts:121
inheritdoc
override
memberof
GdprManager

Returns GdprGuard

toggleForStorage

toggleForStorage(type: GdprStorage): GdprGuard

Implementation of GdprGuardCollection.toggleForStorage
- Defined in node_modules/gdpr-guard/dist/GdprManager.d.ts:146
inheritdoc
override
memberof
GdprManager

Parameters
- type: GdprStorage
Returns GdprGuard

Static create

create(groups?: GdprGuardGroup[]): GdprManager

- Defined in node_modules/gdpr-guard/dist/GdprManager.d.ts:52
Factory for creating a gdpr manager

static
memberof
GdprManager

Parameters
- Optional groups: GdprGuardGroup[]
Returns GdprManager