mirror of
https://github.com/avatao-content/baseimage-tutorial-framework
synced 2024-11-24 01:21:32 +00:00
Created console.read (markdown)
parent
899a42f52e
commit
99b8d1ae04
41
console.read.md
Normal file
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..."
|
||||||
|
}
|
||||||
|
```
|
Loading…
Reference in New Issue
Block a user