Constructor
new WorkflowState(idopt, nameopt, storiesopt)
Creates a new WorkflowState instance.
Parameters:
| Name | Type | Attributes | Default | Description |
|---|---|---|---|---|
id |
number |
<optional> |
0 | The unique identifier for the workflow state |
name |
string |
<optional> |
"" | The name of the workflow state |
stories |
Array.<Story> |
<optional> |
[] | The stories associated with this workflow state |
- Source:
Extends
Classes
Members
client
The Shortcut API client instance used for making API requests
- Overrides:
- Source:
context
The VS Code extension context
- Overrides:
- Source:
id
Unique identifier for the workflow state
- Source:
id :number
Unique identifier for the workflow state
Type:
- number
- Source:
name
Name of the workflow state
- Source:
name :string
Name of the workflow state
Type:
- string
- Source:
stories
Collection of stories that are currently in this workflow state
- Source:
stories :Array
Collection of stories that are currently in this workflow state
Type:
- Array
- Source:
Methods
(static) fromJson(json) → {Array.<WorkflowState>}
Creates an array of WorkflowState instances from JSON data.
Parameters:
| Name | Type | Description |
|---|---|---|
json |
any | The JSON data containing workflow state information |
- Source:
Returns:
An array of WorkflowState instances
- Type
- Array.<WorkflowState>
(static) fromJson(json) → {Array.<WorkflowState>}
Creates an array of WorkflowState instances from JSON data.
Parameters:
| Name | Type | Description |
|---|---|---|
json |
any | The JSON data containing workflow state information |
- Source:
Returns:
An array of WorkflowState instances
- Type
- Array.<WorkflowState>
toObject() → {object}
Converts the WorkflowState instance to a plain JavaScript object.
- Source:
Returns:
A plain object representation of the workflow state
- Type
- object
toObject() → {object}
Converts the WorkflowState instance to a plain JavaScript object.
- Source:
Returns:
A plain object representation of the workflow state
- Type
- object