Interface IStoragePersister

The interface to implement a persistence solution for keeping assets in the modal dressing room over a certain period of time.

This interface is called internally by the prebuild asset providers.

interface IStoragePersister {
    add(v: ReferenceDataWithMetada): void;
    asArray(): ReferenceDataWithMetada[];
    delete(v: ReferenceData): void;
    has(v: ReferenceData): boolean;
}

Index

Methods

add asArray delete has

Methods

add

add(v): void
Adds an asset to the modal dressing room
Parameters
- v: ReferenceDataWithMetada
  The cache id of the asset
Returns void
- Defined in packages/public-types/src/hostAdaptors/staticHostAdaptor/persisters/index.ts:87

asArray

asArray(): ReferenceDataWithMetada[]
Returns the current assets as an array

Returns ReferenceDataWithMetada[]
- Defined in packages/public-types/src/hostAdaptors/staticHostAdaptor/persisters/index.ts:96

delete

delete(v): void
Removes an asset to the modal dressing room
Parameters
- v: ReferenceData
  The cache id of the asset
Returns void
- Defined in packages/public-types/src/hostAdaptors/staticHostAdaptor/persisters/index.ts:92

has

has(v): boolean
Checks if a asset is currently in the dressing room.
Parameters
- v: ReferenceData
  The cache id of the asset
Returns boolean
- Defined in packages/public-types/src/hostAdaptors/staticHostAdaptor/persisters/index.ts:82

Interface IStoragePersister

Index

Methods

Methods

add

Parameters

Returns void

asArray

Returns ReferenceDataWithMetada[]

delete

Parameters

Returns void

has

Parameters

Returns boolean

Settings

On This Page