Skip to main content

Class: TextGlobalPropertyHandle

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.

Extends​

Constructors​

Constructor​

new TextGlobalPropertyHandle(owner, property): TextGlobalPropertyHandle

Parameters​

owner​

GlobalPropertyStateOwner

property​

GlobalPropertyConfigurationAspect

Returns​

TextGlobalPropertyHandle

Overrides​

GlobalPropertyHandle.constructor

Methods​

applyGlobalState()​

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>

Overrides​

GlobalPropertyHandle.applyGlobalState

getDescription()​

getDescription(): string

Returns​

string

A human-friendly description.

Inherited from​

GlobalPropertyHandle.getDescription

getName()​

getName(): string

Returns​

string

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

Inherited from​

GlobalPropertyHandle.getName

getRawProperty()​

getRawProperty(): GlobalPropertyConfigurationAspect

Returns​

GlobalPropertyConfigurationAspect

The underlying property data object.

Inherited from​

GlobalPropertyHandle.getRawProperty

getText()​

getText(): string

Gets the current text

Returns​

string

getTitle()​

getTitle(): string

Returns​

string

A human-friendly title.

Inherited from​

GlobalPropertyHandle.getTitle

getType()​

getType(): AspectType

Returns​

AspectType

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

Inherited from​

GlobalPropertyHandle.getType

isMandatory()​

isMandatory(): boolean

Returns​

boolean

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

Inherited from​

GlobalPropertyHandle.isMandatory

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.

Inherited from​

GlobalPropertyHandle.isMandatoryFulfilled

isSilent()​

isSilent(): boolean

Returns​

boolean

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

Inherited from​

GlobalPropertyHandle.isSilent

isTemplatingEnabled()​

isTemplatingEnabled(): boolean

If this returns false, you should not display any templating tools. Note: Templates will currently still be rendered, regardless of what this function returns.

Returns​

boolean

setText()​

setText(text): Promise<void>

Set the text.

Parameters​

text​

string

Returns​

Promise<void>