Task Class

Task class. A Task is a specific piece of work to accomplish. A Task refers to a Frontstage to activate.

Extends

Methods

Name Description
constructor(taskProps: TaskProps): Task    
onActivated(): Promise<void>    

Inherited methods

Name Inherited from Description
setDescription(v: string | StringGetter | ConditionalStringValue): void ItemDefBase Set the description.
setLabel(v: string | StringGetter | ConditionalStringValue): void ItemDefBase Set the label.
setTooltip(v: string | StringGetter | ConditionalStringValue): void ItemDefBase Set the tooltip.
initializeDef(me: ItemDefBase, itemProps: ItemProps): void Static ItemDefBase  

Properties

Name Type Description
id Accessor ReadOnly string    
isActive Accessor boolean    
primaryStageId string    
taskId string    

Inherited properties

Name Type Inherited from Description
applicationData undefined | any ItemDefBase  
badgeType undefined | BadgeType ItemDefBase  
description Accessor ReadOnly string ItemDefBase Get the description string
iconElement undefined | React.ReactNode ItemDefBase  
iconSpec undefined | IconSpec ItemDefBase  
isDisabled boolean | ConditionalBooleanValue ItemDefBase  
isEnabled boolean ItemDefBase  
isHidden boolean | ConditionalBooleanValue ItemDefBase  
isPressed boolean ItemDefBase  
isVisible boolean ItemDefBase  
label Accessor ReadOnly string ItemDefBase Get the label string
rawLabel Accessor ReadOnly string | StringGetter | ConditionalStringValue ItemDefBase Get the label string
stateFunc undefined | (state: Readonly<BaseItemState>) => BaseItemState ItemDefBase  
stateSyncIds string[] ItemDefBase  
tooltip Accessor ReadOnly string ItemDefBase Get the tooltip string
trayId Accessor ReadOnly undefined ItemDefBase  

Defined in

Last Updated: 15 June, 2021