Class GdprManager

Manage multiple guard groups

Hierarchy

GdprManager

Implements

Properties

bannerWasShown

bannerWasShown: boolean = false

Whether the banner has already been shown to the user

`Readonly` description

description: string = "Manager of GDPR guard groups"

A description of what this guard does

enabled

enabled: boolean = true

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 = "manager"

Unique name of this guard

required

required: boolean = false

Whether this guard is required

`Readonly` storage

storage: GdprStorage = GdprStorage.None

Where this guard is stored

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 GdprManager.ts:111

closeBanner

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

Returns void
- Defined in GdprManager.ts:72

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 GdprManager.ts:100

disable

disable(): GdprGuard
Disable this guard

Returns
this guard

Memberof
GdprGuard

Returns GdprGuard
Implementation of GdprGuardCollection.disable
- Defined in GdprManager.ts:182

disableForStorage

disableForStorage(type: GdprStorage): GdprGuard
Disable guards of the given type (this guard and sub-guards)

Returns
this guard

Memberof
GdprGuard
Parameters
- type: GdprStorage
  
  The storage type to enable all guards for
Returns GdprGuard
Implementation of GdprGuardCollection.disableForStorage
- Defined in GdprManager.ts:221

enable

enable(): GdprGuard
Enable this guard

Returns
this guard

Memberof
GdprGuard

Returns GdprGuard
Implementation of GdprGuardCollection.enable
- Defined in GdprManager.ts:172

enableForStorage

enableForStorage(type: GdprStorage): GdprGuard
Enable guards of the given type (this guard and sub-guards)

Returns
this guard

Memberof
GdprGuard
Parameters
- type: GdprStorage
  
  The storage type to enable all guards for
Returns GdprGuard
Implementation of GdprGuardCollection.enableForStorage
- Defined in GdprManager.ts:212

getGroup

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

Memberof
GdprManager
Parameters
- name: string
Returns null | GdprGuardGroup
- Defined in GdprManager.ts:150

getGroups

getGroups(): GdprGuardGroup[]
Returns GdprGuardGroup[]
- Defined in GdprManager.ts:285

getGuard

getGuard(name: string): null | GdprGuard
Retrieve a guard from the collection

Memberof
GdprGuardCollection
Parameters
- name: string
  
  being the name of the guard to retrieve
Returns null | GdprGuard
Implementation of GdprGuardCollection.getGuard
- Defined in GdprManager.ts:130

hasGroup

hasGroup(name: string): boolean
Inherit Doc

Memberof
GdprManager
Parameters
- name: string
Returns boolean
- Defined in GdprManager.ts:142

hasGuard

hasGuard(name: string): boolean
Determine whether or not the collection has a given guard

Returns
TRUE if it is in its hierarchy, FALSE otherwise

Memberof
GdprGuardCollection
Parameters
- name: string
  
  The name of the guard to look for
Returns boolean
Implementation of GdprGuardCollection.hasGuard
- Defined in GdprManager.ts:121

isEnabled

isEnabled(name: string): boolean
Determine whether or not a guard is enabled

Memberof
GdprGuard
Parameters
- name: string
  
  The name of the guard to look for
Returns boolean
Implementation of GdprGuardCollection.isEnabled
- Defined in GdprManager.ts:163

makeRequired

makeRequired(): GdprGuard
Make this guard required

Returns
this guard

Memberof
GdprGuard

Returns GdprGuard
Implementation of GdprGuardCollection.makeRequired
- Defined in GdprManager.ts:202

raw

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

Returns GdprManagerRaw
Implementation of GdprRawInto.raw
- Defined in GdprManager.ts:240

resetAndShowBanner

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

Returns void
- Defined in GdprManager.ts:89

toggle

toggle(): GdprGuard
Toggle the enabled state of this guard

Returns
this guard

Memberof
GdprGuard

Returns GdprGuard
Implementation of GdprGuardCollection.toggle
- Defined in GdprManager.ts:192

toggleForStorage

toggleForStorage(type: GdprStorage): GdprGuard
Toggle guards of the given type (this guard and sub-guards)

Returns
this guard

Memberof
GdprGuard
Parameters
- type: GdprStorage
  
  The storage type to enable all guards for
Returns GdprGuard
Implementation of GdprGuardCollection.toggleForStorage
- Defined in GdprManager.ts:230

`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 GdprManager.ts:63

Class GdprManager

Hierarchy

Implements

Index

Properties

Methods

Properties

bannerWasShown

Readonly description

enabled

Readonly events

Protected groups

Readonly name

required

Readonly storage

Methods

addGroup

Returns

Memberof

Parameters

category: GdprGuardGroup

Returns GdprManager

closeBanner

Returns void

createGroup

Returns

Memberof

Parameters

name: string

Optional description: string = ""

Returns GdprManager

disable

Returns

Memberof

Returns GdprGuard

disableForStorage

Returns

Memberof

Parameters

type: GdprStorage

Returns GdprGuard

enable

Returns

Memberof

Returns GdprGuard

enableForStorage

Returns

Memberof

Parameters

type: GdprStorage

Returns GdprGuard

getGroup

Inherit Doc

Memberof

Parameters

name: string

Returns null | GdprGuardGroup

getGroups

Returns GdprGuardGroup[]

getGuard

Memberof

Parameters

name: string

Returns null | GdprGuard

hasGroup

Inherit Doc

Memberof

Parameters

name: string

Returns boolean

hasGuard

Returns

Memberof

Parameters

name: string

Returns boolean

isEnabled

Memberof

Parameters

name: string

`Readonly` description

`Readonly` events

`Protected` groups

`Readonly` name

`Readonly` storage

`Optional` description: string = ""

`Static` create

`Optional` groups: GdprGuardGroup[] = []