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): void | ItemDefBase | Set the description. |
setLabel(v: string | StringGetter): void | ItemDefBase | Set the label. |
setTooltip(v: string | StringGetter): 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 | |
betaBadge | boolean | ItemDefBase | |
description Accessor ReadOnly | string | ItemDefBase | Get the description string |
iconElement | undefined | React.ReactNode | ItemDefBase | |
iconSpec | string | React.ReactNode | ItemDefBase | |
isEnabled | boolean | ItemDefBase | |
isPressed | boolean | ItemDefBase | |
isVisible | boolean | ItemDefBase | |
label Accessor ReadOnly | string | 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: 05 June, 2020