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

Created console.read (markdown)

ni-richard 2019-09-12 14:27:06 +02:00
parent 899a42f52e
commit 99b8d1ae04
1 changed files with 41 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

41
console.read.md Normal file

@ -0,0 +1,41 @@
### Request
* **Description**: Retrieves the console's content.
* **Subscribers**: *(none)*
```json
{
"key": "console.read",
"scope": "websocket"
}
```
***
**Example**: Same as above, does not have additional parameters.
### Response
* **Description**: Returns the current content of the console.
* **Subscribers**: *(none)*
```json
{
"key": "console.read",
"intent": "event",
"scope": "zmq"
}
```
| Parameter | Type | Required | Description |
| ------------ |:--------:|:------------------:| --------------------------- |
| *content* | `string` | :heavy_check_mark: | Text stored inside the console. |
***
**Example**:
```json
{
"key": "console.read",
"intent": "event",
"content": " * Serving Flask app..."
}
```