Class GdprGroupBuilder

Builder for a gdpr group

Export

Hierarchy

GdprManagerBuilder
- GdprGroupBuilder

Properties

bannerWasShown

bannerWasShown: boolean

`Protected` description

description: string

`Protected` enable

enable: boolean

groups

groups: GdprGuardGroup[]

guards

guards: GdprGuard[]

`Protected` name

name: string

`Protected` parent

parent: GdprManagerBuilder

`Protected` require

require: boolean

storage

storage: GdprStorage

Methods

build

build(): GdprManager
Build the manager from the current builder state

Returns

Memberof
GdprManagerBuilder

Returns GdprManager
Inherited from GdprManagerBuilder.build
- Defined in node_modules/gdpr-guard/dist/builders/GdprManagerBuilder.d.ts:64

disabled

disabled(): GdprGroupBuilder
Mark as disabled

Returns

Memberof
GdprGroupBuilder

Returns GdprGroupBuilder
- Defined in node_modules/gdpr-guard/dist/builders/GdprGroupBuilder.d.ts:76

enabled

enabled(): GdprGroupBuilder
Mark as enabled

Returns

Memberof
GdprGroupBuilder

Returns GdprGroupBuilder
- Defined in node_modules/gdpr-guard/dist/builders/GdprGroupBuilder.d.ts:70

endGroup

endGroup(): GdprManagerBuilder
End the group using the current builder state

Returns

Memberof
GdprGroupBuilder

Returns GdprManagerBuilder
Overrides GdprManagerBuilder.endGroup
- Defined in node_modules/gdpr-guard/dist/builders/GdprGroupBuilder.d.ts:43

required

required(): GdprGroupBuilder
Mark as required

Returns

Memberof
GdprGroupBuilder

Returns GdprGroupBuilder
- Defined in node_modules/gdpr-guard/dist/builders/GdprGroupBuilder.d.ts:82

startDisabledGroup

startDisabledGroup(storage?: null | GdprStorage, name?: string, description?: string): GdprGroupBuilder
Start a new disabled group

Returns

Memberof
GdprManagerBuilder
Parameters
- Optional storage: null | GdprStorage
  
  The storage type of the group
- Optional name: string
  
  The name of the group
- Optional description: string
  
  The description of the group
Returns GdprGroupBuilder
Inherited from GdprManagerBuilder.startDisabledGroup
- Defined in node_modules/gdpr-guard/dist/builders/GdprManagerBuilder.d.ts:58

startEnabledGroup

startEnabledGroup(storage?: null | GdprStorage, name?: string, description?: string): GdprGroupBuilder
Start a new enabled group

Returns

Memberof
GdprManagerBuilder
Parameters
- Optional storage: null | GdprStorage
  
  The storage type of the group
- Optional name: string
  
  The name of the group
- Optional description: string
  
  The description of the group
Returns GdprGroupBuilder
Inherited from GdprManagerBuilder.startEnabledGroup
- Defined in node_modules/gdpr-guard/dist/builders/GdprManagerBuilder.d.ts:49

startGroup

startGroup(storage?: null | GdprStorage, name?: string, description?: string): GdprGroupBuilder
Start a new group

Returns

Memberof
GdprManagerBuilder
Parameters
- Optional storage: null | GdprStorage
  
  The storage type of the group
- Optional name: string
  
  The name of the group
- Optional description: string
  
  The description of the group
Returns GdprGroupBuilder
Overrides GdprManagerBuilder.startGroup
- Defined in node_modules/gdpr-guard/dist/builders/GdprGroupBuilder.d.ts:36

startGuard

startGuard(storage?: null | GdprStorage): GdprGuardBuilder
Start adding a guard

Returns

Memberof
GdprGroupBuilder
Parameters
- Optional storage: null | GdprStorage
  
  The storage for the guard (by default it uses the group's storage)
Returns GdprGuardBuilder
- Defined in node_modules/gdpr-guard/dist/builders/GdprGroupBuilder.d.ts:89

startRequiredGroup

startRequiredGroup(storage?: null | GdprStorage, name?: string, description?: string): GdprGroupBuilder
Start a new group as required

Returns

Memberof
GdprManagerBuilder
Parameters
- Optional storage: null | GdprStorage
  
  The storage type of the group
- Optional name: string
  
  The name of the group
- Optional description: string
  
  The description of the group
Returns GdprGroupBuilder
Overrides GdprManagerBuilder.startRequiredGroup
- Defined in node_modules/gdpr-guard/dist/builders/GdprGroupBuilder.d.ts:37

startRequiredGuard

startRequiredGuard(storage?: null | GdprStorage): GdprGuardBuilder
Start adding a required guard

Returns

Memberof
GdprGroupBuilder
Parameters
- Optional storage: null | GdprStorage
  
  The storage for the guard (by default it uses the group's storage)
Returns GdprGuardBuilder
- Defined in node_modules/gdpr-guard/dist/builders/GdprGroupBuilder.d.ts:96

storedIn

storedIn(storage: GdprStorage): GdprGroupBuilder
Set the storage of the group

Returns

Memberof
GdprGroupBuilder
Parameters
- storage: GdprStorage
  
  The new storage for the group
Returns GdprGroupBuilder
- Defined in node_modules/gdpr-guard/dist/builders/GdprGroupBuilder.d.ts:64

withBannerShown

withBannerShown(wasShown?: boolean): void
Parameters
- Optional wasShown: boolean
Returns void
Inherited from GdprManagerBuilder.withBannerShown
- Defined in node_modules/gdpr-guard/dist/builders/GdprManagerBuilder.d.ts:21

withDescription

withDescription(description: string): GdprGroupBuilder
Set the description of the group

Returns

Memberof
GdprGroupBuilder
Parameters
- description: string
  
  The new description for the group
Returns GdprGroupBuilder
- Defined in node_modules/gdpr-guard/dist/builders/GdprGroupBuilder.d.ts:57

withDisabledGuard

withDisabledGuard(name: string, description?: string, storage?: null | GdprStorage): GdprGroupBuilder
Add a disabled guard

Returns

Memberof
GdprGroupBuilder
Parameters
- name: string
  
  The name of the guard
- Optional description: string
  
  The description of the guard
- Optional storage: null | GdprStorage
  
  The storage of the guard
Returns GdprGroupBuilder
- Defined in node_modules/gdpr-guard/dist/builders/GdprGroupBuilder.d.ts:114

withEnabledGuard

withEnabledGuard(name: string, description?: string, storage?: null | GdprStorage): GdprGroupBuilder
Add an enabled guard

Returns

Memberof
GdprGroupBuilder
Parameters
- name: string
  
  The name of the guard
- Optional description: string
  
  The description of the guard
- Optional storage: null | GdprStorage
  
  The storage of the guard
Returns GdprGroupBuilder
- Defined in node_modules/gdpr-guard/dist/builders/GdprGroupBuilder.d.ts:105

withName

withName(name: string): GdprGroupBuilder
Set the name of the group

Returns

Memberof
GdprGroupBuilder
Parameters
- name: string
  
  The new name for the group
Returns GdprGroupBuilder
- Defined in node_modules/gdpr-guard/dist/builders/GdprGroupBuilder.d.ts:50

`Static` create

create(mb: GdprManagerBuilder, name: string, description?: string, storage?: null | GdprStorage, enabled?: boolean, required?: boolean): GdprGroupBuilder
Factory for a group builder

Static

Returns

Memberof
GdprGroupBuilder
Parameters
- mb: GdprManagerBuilder
  
  The parent manager builder
- name: string
  
  The name of the group
- Optional description: string
  
  The description of the group
- Optional storage: null | GdprStorage
  
  The storage of the group
- Optional enabled: boolean
  
  Whether or not the group should be enabled
- Optional required: boolean
  
  Whether or not the group should be required
Returns GdprGroupBuilder
- Defined in node_modules/gdpr-guard/dist/builders/GdprGroupBuilder.d.ts:35

`Static` make

make(): GdprManagerBuilder
Factory for a builder

Static

Returns

Memberof
GdprManagerBuilder

Returns GdprManagerBuilder
Inherited from GdprManagerBuilder.make
- Defined in node_modules/gdpr-guard/dist/builders/GdprManagerBuilder.d.ts:20

Class GdprGroupBuilder

Export

Hierarchy

Index

Properties

Methods

Properties

bannerWasShown

Protected description

Protected enable

groups

guards

Protected name

Protected parent

Protected require

storage

Methods

build

Returns

Memberof

Returns GdprManager

disabled

Returns

Memberof

Returns GdprGroupBuilder

enabled

Returns

Memberof

Returns GdprGroupBuilder

endGroup

Returns

Memberof

Returns GdprManagerBuilder

required

Returns

Memberof

Returns GdprGroupBuilder

startDisabledGroup

Returns

Memberof

Parameters

Optional storage: null | GdprStorage

Optional name: string

Optional description: string

Returns GdprGroupBuilder

startEnabledGroup

Returns

Memberof

Parameters

Optional storage: null | GdprStorage

Optional name: string

Optional description: string

Returns GdprGroupBuilder

startGroup

Returns

Memberof

Parameters

Optional storage: null | GdprStorage

Optional name: string

Optional description: string

Returns GdprGroupBuilder

startGuard

Returns

Memberof

Parameters

Optional storage: null | GdprStorage

Returns GdprGuardBuilder

startRequiredGroup

Returns

Memberof

Parameters

Optional storage: null | GdprStorage

Optional name: string

Optional description: string

Returns GdprGroupBuilder

startRequiredGuard

Returns

Memberof

Parameters

Optional storage: null | GdprStorage

`Protected` description

`Protected` enable

`Protected` name

`Protected` parent

`Protected` require

`Optional` storage: null | GdprStorage

`Optional` name: string

`Optional` description: string

`Optional` storage: null | GdprStorage

`Optional` name: string

`Optional` description: string

`Optional` storage: null | GdprStorage

`Optional` name: string

`Optional` description: string

`Optional` storage: null | GdprStorage

`Optional` storage: null | GdprStorage

`Optional` name: string

`Optional` description: string

`Optional` storage: null | GdprStorage

`Optional` wasShown: boolean

`Optional` description: string

`Optional` storage: null | GdprStorage

`Optional` description: string

`Optional` storage: null | GdprStorage

`Static` create

`Optional` description: string

`Optional` storage: null | GdprStorage

`Optional` enabled: boolean

`Optional` required: boolean

`Static` make