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
Add a group to this manager

Returns

Memberof
GdprManager
Parameters
- category: GdprGuardGroup
  
  The group to add
Returns GdprManager
- Defined in node_modules/gdpr-guard/dist/GdprManager.d.ts:75

closeBanner

closeBanner(): void
Mark the GDPR banner as shown and trigger enable and disable events

Returns void
- Defined in node_modules/gdpr-guard/dist/GdprManager.d.ts:56

createGroup

createGroup(name: string, description?: string): GdprManager
Create and add a group to this manager

Returns

Memberof
GdprManager
Parameters
- name: string
  
  The new group's name
- Optional description: string
  
  The new group's description
Returns GdprManager
- Defined in node_modules/gdpr-guard/dist/GdprManager.d.ts:68

disable

disable(): GdprGuard
Inherit Doc

Memberof
GdprManager

Returns GdprGuard
Implementation of GdprGuardCollection.disable
- Defined in node_modules/gdpr-guard/dist/GdprManager.d.ts:115

disableForStorage

disableForStorage(type: GdprStorage): GdprGuard
Inherit Doc

Memberof
GdprManager
Parameters
- type: GdprStorage
Returns GdprGuard
Implementation of GdprGuardCollection.disableForStorage
- Defined in node_modules/gdpr-guard/dist/GdprManager.d.ts:140

enable

enable(): GdprGuard
Inherit Doc

Memberof
GdprManager

Returns GdprGuard
Implementation of GdprGuardCollection.enable
- Defined in node_modules/gdpr-guard/dist/GdprManager.d.ts:109

enableForStorage

enableForStorage(type: GdprStorage): GdprGuard
Inherit Doc

Memberof
GdprManager
Parameters
- type: GdprStorage
Returns GdprGuard
Implementation of GdprGuardCollection.enableForStorage
- Defined in node_modules/gdpr-guard/dist/GdprManager.d.ts:134

getGroup

getGroup(name: string): null | GdprGuardGroup
Inherit Doc

Memberof
GdprManager
Parameters
- name: string
Returns null | GdprGuardGroup
- Defined in node_modules/gdpr-guard/dist/GdprManager.d.ts:97

getGroups

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

getGuard

getGuard(name: string): null | GdprGuard
Inherit Doc

Memberof
GdprManager
Parameters
- name: string
Returns null | GdprGuard
Implementation of GdprGuardCollection.getGuard
- Defined in node_modules/gdpr-guard/dist/GdprManager.d.ts:87

hasGroup

hasGroup(name: string): boolean
Inherit Doc

Memberof
GdprManager
Parameters
- name: string
Returns boolean
- Defined in node_modules/gdpr-guard/dist/GdprManager.d.ts:92

hasGuard

hasGuard(name: string): boolean
Inherit Doc

Memberof
GdprManager
Parameters
- name: string
Returns boolean
Implementation of GdprGuardCollection.hasGuard
- Defined in node_modules/gdpr-guard/dist/GdprManager.d.ts:81

isEnabled

isEnabled(name: string): boolean
Inherit Doc

Memberof
GdprManager
Parameters
- name: string
Returns boolean
Implementation of GdprGuardCollection.isEnabled
- Defined in node_modules/gdpr-guard/dist/GdprManager.d.ts:103

makeRequired

makeRequired(): GdprGuard
Does nothing for a manager

Inherit Doc

Memberof
GdprManager

Returns GdprGuard
Implementation of GdprGuardCollection.makeRequired
- Defined in node_modules/gdpr-guard/dist/GdprManager.d.ts:128

raw

raw(): GdprManagerRaw
Raw/simple representation of this guard

Returns GdprManagerRaw
Implementation of GdprRawInto.raw
- Defined in node_modules/gdpr-guard/dist/GdprManager.d.ts:153

resetAndShowBanner

resetAndShowBanner(): void
Reset the state of the GDPR banner and show it

Returns void
- Defined in node_modules/gdpr-guard/dist/GdprManager.d.ts:60

toggle

toggle(): GdprGuard
Inherit Doc

Memberof
GdprManager

Returns GdprGuard
Implementation of GdprGuardCollection.toggle
- Defined in node_modules/gdpr-guard/dist/GdprManager.d.ts:121

toggleForStorage

toggleForStorage(type: GdprStorage): GdprGuard
Inherit Doc

Memberof
GdprManager
Parameters
- type: GdprStorage
Returns GdprGuard
Implementation of GdprGuardCollection.toggleForStorage
- Defined in node_modules/gdpr-guard/dist/GdprManager.d.ts:146

`Static` create

create(groups?: GdprGuardGroup[]): GdprManager
Factory for creating a gdpr manager

Static

Returns

Memberof
GdprManager
Parameters
- Optional groups: GdprGuardGroup[]
  
  The initial guard groups
Returns GdprManager
- Defined in node_modules/gdpr-guard/dist/GdprManager.d.ts:52