Class GdprManagerBuilder

Builder for a GdprManager

Export

Hierarchy

GdprManagerBuilder
- GdprGroupBuilder

Index

Constructors

Properties

bannerWasShown groups storage

Methods

build endGroup startDisabledGroup startEnabledGroup startGroup startRequiredGroup withBannerShown make

Constructors

constructor

new GdprManagerBuilder(): GdprManagerBuilder
Returns GdprManagerBuilder

Properties

bannerWasShown

bannerWasShown: boolean = false

groups

groups: GdprGuardGroup[] = []

storage

storage: GdprStorage = GdprStorage.Cookie

Methods

build

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

Returns

Memberof
GdprManagerBuilder

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

endGroup

endGroup(): GdprManagerBuilder
End this group's creation (no-op for manager builders)

Returns

Memberof
GdprManagerBuilder

Returns GdprManagerBuilder
- Defined in builders/GdprManagerBuilder.ts:95

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
- 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
- Defined in builders/GdprManagerBuilder.ts:63

startGroup

startGroup(storage??: null | GdprStorage, name??: string, description??: string, enabled??: boolean): GdprGroupBuilder
Start a new 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
- Optional enabled: boolean = true
  
  Whether or not the group is enabled
Returns GdprGroupBuilder
- Defined in builders/GdprManagerBuilder.ts:39

startRequiredGroup

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

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
- Defined in builders/GdprManagerBuilder.ts:51

withBannerShown

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

`Static` make

make(): GdprManagerBuilder
Factory for a builder

Static

Returns

Memberof
GdprManagerBuilder

Returns GdprManagerBuilder
- Defined in builders/GdprManagerBuilder.ts:22