Class GdprSaviorAdapter`Abstract`

Handle saving/restoring/checking semantics

Interface

GdprSavior

Export

Hierarchy

GdprSaviorAdapter

Implements

GdprSavior

Index

Constructors

Properties

Methods

check decorate exists restore restoreOrCreate store storeIfNotExists updateSharedManager

Constructors

constructor

new GdprSaviorAdapter(decorator?: undefined | GdprManagerDecorator): GdprSaviorAdapter
Parameters
- decorator: undefined | GdprManagerDecorator = undefined
Returns GdprSaviorAdapter
- Defined in serde/GdprSavior.ts:66

Properties

`Protected` decorator

decorator: undefined | GdprManagerDecorator = undefined

Methods

check

check(): Promise<void>
Check if there is an existing manager state (should rely on GdprSavior#exists)

Returns Promise<void>
Implementation of GdprSavior.check
- Defined in serde/GdprSavior.ts:141

decorate

decorate(manager: GdprManager): GdprManager
Inherit Doc
Parameters
- manager: GdprManager
Returns GdprManager
Implementation of GdprSavior.decorate
- Defined in serde/GdprSavior.ts:151

exists

exists(shouldUpdate?: boolean): Promise<boolean>
Determine whether there is already an existing manager (saved state)
Parameters
- shouldUpdate: boolean = true
  
  Whether it should update its savior internals (should default to true)
Returns Promise<boolean>
Implementation of GdprSavior.exists
- Defined in serde/GdprSavior.ts:93

`Abstract` restore

restore(shouldUpdate?: boolean): Promise<null | GdprManager>
Restore the manager (saved state)
Parameters
- Optional shouldUpdate: boolean
  
  Whether it should update its savior internals (should default to true)
Returns Promise<null | GdprManager>
Implementation of GdprSavior.restore
- Defined in serde/GdprSavior.ts:72

restoreOrCreate

restoreOrCreate(factory: GdprManagerFactory): Promise<GdprManager>
Restore the manager or create one using the factory

Warning
This should not store/save the manager before returning it
Parameters
- factory: GdprManagerFactory
  
  Factory to create a manager (default manager state)
Returns Promise<GdprManager>
Implementation of GdprSavior.restoreOrCreate
- Defined in serde/GdprSavior.ts:113

`Abstract` store

store(manager: GdprManagerRaw): Promise<boolean>
Overwrite the saved state of the manager
Parameters
- manager: GdprManagerRaw
  
  The manager to store (state to save)
Returns Promise<boolean>
Implementation of GdprSavior.store
- Defined in serde/GdprSavior.ts:79

storeIfNotExists

storeIfNotExists(manager: GdprManagerRaw): Promise<boolean>
Store the manager state if none is already save
Parameters
- manager: GdprManagerRaw
  
  The manager to store (state to save)
Returns Promise<boolean>
Implementation of GdprSavior.storeIfNotExists
- Defined in serde/GdprSavior.ts:103

`Abstract` updateSharedManager

updateSharedManager(manager: GdprManager): Promise<void>
Handle shared state updates
Parameters
- manager: GdprManager
  
  The new manager to use
Returns Promise<void>
Implementation of GdprSavior.updateSharedManager
- Defined in serde/GdprSavior.ts:86