Type Definitions
CommsConnection
A WebSocket connection between the runtime and the editor.
Properties:
| Name | Type | Description |
|---|---|---|
session |
string
|
a unique session identifier |
user |
Object
|
the user associated with the connection |
send |
function
|
publish a message to the connection |
Flow
Properties:
| Name | Type | Description |
|---|---|---|
id |
string
|
the flow identifier |
label |
string
|
a label for the flow |
nodes |
Array
|
an array of node configuration objects |
Flows
Properties:
| Name | Type | Description |
|---|---|---|
rev |
string
|
the flow revision identifier |
flows |
Array
|
the flow configuration, an array of node configuration objects |
User
A user accessing the API