mrtoth/baseimage-tutorial-framework
1
0
Fork 0
mirror of https://github.com/avatao-content/baseimage-tutorial-framework synced 2024-11-22 14:21:33 +00:00
Code Issues Releases Wiki Activity

Add note on FSM update messages in API docs

Browse Source
This commit is contained in:
Kristóf Tóth 2018-07-12 15:30:10 +02:00
parent b06472ad19
commit da98576260
1 changed files with 14 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
README.md
View File

@ -244,7 +244,7 @@ To set the tail length of logs (the monitor will send back the last `value` char
### FSMManagingEventHandler
To attempt executing a trigger on the FSM use:
To attempt executing a trigger on the FSM use (this will also generate an FSM update message):
```
{
"key": "fsm",
@ -266,3 +266,16 @@ To force the broadcasting of an FSM update you can use this message:
}
}
```
This event handler broadcasts FSM update messages after handling commands in the following format:
```
{
"key": "fsm_update",
"data" :
{
"current_state": ...string...,
"valid_transitions": ...array of {"trigger": ...string...} objects...
}
}
```