Skip to content

Commit

Permalink
ramble on about activity status
Browse files Browse the repository at this point in the history
  • Loading branch information
paed01 committed Nov 17, 2024
1 parent f80bde3 commit 9b22f98
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions docs/API.md
Original file line number Diff line number Diff line change
Expand Up @@ -555,11 +555,11 @@ engine.resume({ listener }, () => {
- `broker`: engine message broker
- `environment`: execution environment
- `definitions`: list of definitions
- `activityStatus`: string, execution activity status
- `activityStatus`: string, execution activity status, e.g. if `wait` or `timer` **no** activities are `executing`, if `executing` there can be both running timers and waiting tasks, if `timer` there can be waiting activities but **no** `executing` activities, and so forth
- `executing`: at least one activity is executing, e.g. a service task making a asynchronous request
- `timer`: at least one activity is waiting for a timer to complete, usually only TimerEventDefinition's
- `wait`: at least one activity is waiting for a signal of some sort, e.g. user tasks, intermediate catch events, etc
- `idle`: idle, no activities are running
- `idle`: idle, no activities are running, the engine is not running at all
- `isRunning`: are any definition running?
- `getActivityById(activityId)`(#getactivitybyid-activityid): get activity/element by id, returns first found among definitions
- `getState()`: get execution state
Expand Down

0 comments on commit 9b22f98

Please sign in to comment.