Class GdprGroupBuilder

Builder for a gdpr group

Export

Hierarchy

GdprManagerBuilder
- GdprGroupBuilder

Properties

bannerWasShown

bannerWasShown: boolean = false

`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 = GdprStorage.Cookie

Methods

build

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

Returns

Memberof
GdprManagerBuilder

Returns GdprManager
Inherited from GdprManagerBuilder.build
- Defined in builders/GdprManagerBuilder.ts:84

disabled

disabled(): GdprGroupBuilder
Mark as disabled

Returns

Memberof
GdprGroupBuilder

Returns GdprGroupBuilder
- Defined in builders/GdprGroupBuilder.ts:120

enabled

enabled(): GdprGroupBuilder
Mark as enabled

Returns

Memberof
GdprGroupBuilder

Returns GdprGroupBuilder
- Defined in builders/GdprGroupBuilder.ts:111

endGroup

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

Returns

Memberof
GdprGroupBuilder

Returns GdprManagerBuilder
Overrides GdprManagerBuilder.endGroup
- Defined in builders/GdprGroupBuilder.ts:63

required

required(): GdprGroupBuilder
Mark as required

Returns

Memberof
GdprGroupBuilder

Returns GdprGroupBuilder
- Defined in builders/GdprGroupBuilder.ts:129

startDisabledGroup

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

Returns

Memberof
GdprManagerBuilder
Parameters
- Optional storage: null | GdprStorage = null
  
  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 builders/GdprManagerBuilder.ts:75

startEnabledGroup

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

Returns

Memberof
GdprManagerBuilder
Parameters
- Optional storage: null | GdprStorage = null
  
  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 builders/GdprManagerBuilder.ts:63

startGroup

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

Returns

Memberof
GdprManagerBuilder
Parameters
- storage: null | GdprStorage = null
  
  The storage type of the group
- name: string = ""
  
  The name of the group
- description: string = ""
  
  The description of the group
Returns GdprGroupBuilder
Overrides GdprManagerBuilder.startGroup
- Defined in builders/GdprGroupBuilder.ts:50

startGuard

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

Returns

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

startRequiredGroup

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

Returns

Memberof
GdprManagerBuilder
Parameters
- storage: null | GdprStorage = null
  
  The storage type of the group
- name: string = ""
  
  The name of the group
- description: string = ""
  
  The description of the group
Returns GdprGroupBuilder
Overrides GdprManagerBuilder.startRequiredGroup
- Defined in builders/GdprGroupBuilder.ts:54

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 builders/GdprGroupBuilder.ts:149

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 builders/GdprGroupBuilder.ts:102

withBannerShown

withBannerShown(wasShown?: boolean): void
Parameters
- wasShown: boolean = true
Returns void
Inherited from GdprManagerBuilder.withBannerShown
- Defined in builders/GdprManagerBuilder.ts:26

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 builders/GdprGroupBuilder.ts:92

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 = null
  
  The storage of the guard
Returns GdprGroupBuilder
- Defined in builders/GdprGroupBuilder.ts:177

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 = null
  
  The storage of the guard
Returns GdprGroupBuilder
- Defined in builders/GdprGroupBuilder.ts:161

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 builders/GdprGroupBuilder.ts:82

`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 = null
  
  The storage of the group
- Optional enabled: boolean = true
  
  Whether or not the group should be enabled
- Optional required: boolean = false
  
  Whether or not the group should be required
Returns GdprGroupBuilder
- Defined in builders/GdprGroupBuilder.ts:46

`Static` make

make(): GdprManagerBuilder
Factory for a builder

Static

Returns

Memberof
GdprManagerBuilder

Returns GdprManagerBuilder
Inherited from GdprManagerBuilder.make
- Defined in builders/GdprManagerBuilder.ts:22

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 = null

Optional name: string = ""

Optional description: string = ""

Returns GdprGroupBuilder

startEnabledGroup

Returns

Memberof

Parameters

Optional storage: null | GdprStorage = null

Optional name: string = ""

Optional description: string = ""

Returns GdprGroupBuilder

startGroup

Returns

Memberof

Parameters

storage: null | GdprStorage = null

name: string = ""

description: string = ""

Returns GdprGroupBuilder

startGuard

Returns

Memberof

Parameters

Optional storage: null | GdprStorage = null

Returns GdprGuardBuilder

startRequiredGroup

Returns

Memberof

Parameters

storage: null | GdprStorage = null

name: string = ""

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 = null

`Optional` name: string = ""

`Optional` description: string = ""

`Optional` storage: null | GdprStorage = null

`Optional` name: string = ""

`Optional` description: string = ""

`Optional` storage: null | GdprStorage = null

`Optional` storage: null | GdprStorage

`Optional` description: string = ""

`Optional` storage: null | GdprStorage = null

`Optional` description: string = ""

`Optional` storage: null | GdprStorage = null

`Static` create

`Optional` description: string = ""

`Optional` storage: null | GdprStorage = null

`Optional` enabled: boolean = true

`Optional` required: boolean = false

`Static` make