Abstract Class: StepHandle<T>
A StepHandle allows for managing the state of a specific step in a workflow. This class abstracts away the complexities of dealing with a step directly and allows for using high level concepts instead of dealing with the underlying data structures.
Extended by
DigitalContentStepHandleModuleStepHandleTextStepHandleFrameStepHandleShapeStepHandleInformationStepHandleIllustrationStepHandleMaterialStepHandleModelStepHandlePictureStepHandleProductStepHandleQuestionStepHandle
Type Parameters
T
T extends AnyStepData
Constructors
Constructor
new StepHandle<
T>(manager,step,tags):StepHandle<T>
Parameters
manager
step
Step<T>
tags
string[]
Returns
StepHandle<T>
Methods
executeAnimations()
executeAnimations(
immediate?):void
Fires any configured animations on the 3D preview for this step. This includes camera & model animations. If the preview is unavailable this function will do nothing.
Parameters
immediate?
boolean
Returns
void
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
getGlobalPropertyAspects()
getGlobalPropertyAspects(
configurationId):string[]
Retrieves the identifiers of all of the configured aspects for the specified Global Property Configuration.
Parameters
configurationId
string
The ID of the Global Property Configuration. You can usually find this with bundle.getGlobalPropertyConfiguration()?.id
Returns
string[]
An array of strings matching the keys of all the Global Property Aspects in the Configuration that this step is configured to use.
getHelpText()
getHelpText():
string|undefined
Returns
string | undefined
A message that can accompany the step name in UI components. Used to describe the purpose of the step in more detail.
getId()
getId():
string
Returns
string
A unique identifier for this step within the workflow.
getMandatory()
getMandatory():
boolean
Returns
boolean
True if the step is required to be filled by the customer. False otherwise.
getName()
getName():
string
Returns
string
The name of the step
getOverrideGlobalPropertyConfiguration()
getOverrideGlobalPropertyConfiguration(
type):boolean
Parameters
type
The AspectType to fetch the value for.
Returns
boolean
A boolean indicating whether this step should override Global Properties. Only relevant when the Workflow Experience is associated with a Bundle that is using Global Properties, and when this step is associated with one or more Global Property Aspects.
getRaw()
getRaw():
Step<T>
Returns
Step<T>
The underlying data for this step. Favor using the step handle methods instead of this.
getTags()
getTags():
string[]
Returns
string[]
Returns all of the tags that are present on this step.
getType()
getType():
StepType
Returns
The type of the step handle.
hasTag()
hasTag(
tag):boolean
Parameters
tag
string
The tag to check for.
Returns
boolean
True if the step has the specified tag, false otherwise.
selectVariant()
abstractselectVariant(variant):Promise<void>
Most step types have a base option type that variants can be selected for. Selects a specific variant for this step. This will execute all required changes to the design and update the metadata to include the new selection. Any conditions that would be triggered will also be executed.
Parameters
variant
Returns
Promise<void>
setOverrideGlobalPropertyConfiguration()
setOverrideGlobalPropertyConfiguration(
type,value):void
Sets whether or not this step should override Global Properties. Only relevant when the Workflow Experience is associated with a Bundle that is using Global Properties, and when this step is associated with one or more Global Property Aspects.
Parameters
type
The AspectType to override.
value
boolean
Returns
void