Skip to main content

Interface: GlobalPropertyStateManager

Methods​

clearAspects()​

clearAspects(names): Promise<void>

Parameters​

names​

string[]

Returns​

Promise<void>

getAspect()​

getAspect(name, channel?): string | undefined

Parameters​

name​

string

channel?​

number

Returns​

string | undefined

getAspectHidden()​

getAspectHidden(name): boolean

Parameters​

name​

string

Returns​

boolean

getAspectMandatoryFulfilled()​

getAspectMandatoryFulfilled(name): boolean | undefined

Parameters​

name​

string

Returns​

boolean | undefined

getAspectStorage()​

getAspectStorage<S>(name, channel?): S | undefined

Type Parameters​

S​

S extends GlobalPropertyStateAspectStorage

Parameters​

name​

string

channel?​

number

Returns​

S | undefined

getBundleOptions()​

getBundleOptions(): BundleOptions | undefined

Returns​

BundleOptions | undefined

getGlobalPropertyState()​

getGlobalPropertyState(): GlobalPropertyState | undefined

Returns​

GlobalPropertyState | undefined

getInitializationPromise()​

getInitializationPromise(): Promise<void>

Returns​

Promise<void>

setAspect()​

setAspect(name, value, storage?, channel?, hidden?): Promise<void>

Updates the value of a named aspect in the state.

Parameters​

name​

string

The name (key) of the aspect. This must match the key in the associated Global Property Config

value​

string

The value, represented as a string.

storage?​

GlobalPropertyStateAspectStorage | null

Optional: Additional data storage for the aspect. Not specifying this parameter, or providing undefined, will not update the storage (if it already exists). Providing null will clear the existing storage.

channel?​

number

Optional: Additional sub-identifier.

hidden?​

boolean

Returns​

Promise<void>

setAspectStorage()​

setAspectStorage<S>(name, storage, channel?): Promise<void>

Type Parameters​

S​

S extends GlobalPropertyStateAspectStorage

Parameters​

name​

string

storage​

S | null

channel?​

number

Returns​

Promise<void>

setBundleOptions()​

setBundleOptions(bundleOptions?): void

Parameters​

bundleOptions?​

BundleOptions

Returns​

void

setConfiguration()​

setConfiguration(configuration): void

Parameters​

configuration​

GlobalPropertyConfiguration | undefined

Returns​

void

setGlobalPropertyState()​

setGlobalPropertyState(state): Promise<void>

Parameters​

state​

GlobalPropertyState

Returns​

Promise<void>