Skip to main content

Class: OptionGlobalPropertyHandle

An option property handle represents a property that can affect the option of steps across multiple transactions.

Extends​

Extended by​

Constructors​

Constructor​

new OptionGlobalPropertyHandle(owner, property, optionResource): OptionGlobalPropertyHandle

Parameters​

owner​

GlobalPropertyStateOwner

property​

GlobalPropertyConfigurationAspect

optionResource​

OptionResource | undefined

Returns​

OptionGlobalPropertyHandle

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

getAllVariants()​

getAllVariants(): Promise<Variant[]>

Returns​

Promise<Variant[]>

A list of all variants for this step, including disabled ones.

getAvailableVariants()​

getAvailableVariants(): Promise<Variant[]>

Returns​

Promise<Variant[]>

A list of valid variants for this step. Does not include disabled variants.

getCurrentVariant()​

getCurrentVariant(): Variant | undefined

Gets the currently selected variant, or undefined if no variant is selected.

Returns​

Variant | undefined

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

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

initDefaultVariant()​

initDefaultVariant(): Promise<void>

If the option has a default variant, select it.

Returns​

Promise<void>

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

selectVariant()​

selectVariant(variant, channel?): Promise<void>

Select a given variant on the option for all shared steps.

Parameters​

variant​

Variant

The variant to select.

channel?​

number

Returns​

Promise<void>