Skip to main content

Abstract Class: GlobalPropertyHandle

A GlobalPropertyHandle acts as an interface to global properties on our platform. Currently bundles can return a handle for any global properties associated to the collection.

Extended by​

Constructors​

Constructor​

new GlobalPropertyHandle(owner, property): GlobalPropertyHandle

Parameters​

owner​

GlobalPropertyStateOwner

property​

GlobalPropertyConfigurationAspect

Returns​

GlobalPropertyHandle

Methods​

applyGlobalState()​

abstract applyGlobalState(targetExperiences?): Promise<void>

Applies the global state to all shared steps, if the state is set.

Parameters​

targetExperiences?​

WorkflowExperience[]

Optionally filter the workflow experiences it should be applied to.

Returns​

Promise<void>

getDescription()​

getDescription(): string

Returns​

string

A human-friendly description.

getName()​

getName(): string

Returns​

string

The name of the global property. This is the key used to store the property in the state.

getRawProperty()​

getRawProperty(): GlobalPropertyConfigurationAspect

Returns​

GlobalPropertyConfigurationAspect

The underlying property data object.

getTitle()​

getTitle(): string

Returns​

string

A human-friendly title.

getType()​

getType(): AspectType

Returns​

AspectType

The type of the global property. Use this to determine how to render the property.

isMandatory()​

isMandatory(): boolean

Returns​

boolean

Whether this aspect has been marked as required to be completed before the user can continue.

isMandatoryFulfilled()​

isMandatoryFulfilled(): boolean

Returns​

boolean

Whether this aspect has been marked as completed for mandatory checks. Note that this function always returns true if the aspect has not been marked as mandatory.

isSilent()​

isSilent(): boolean

Returns​

boolean

Whether this aspect has been marked as silent and therefore should not be displayed to the user.