From 99b8d1ae04137c7ecec5f96880173715fc59a5ab Mon Sep 17 00:00:00 2001 From: ni-richard Date: Thu, 12 Sep 2019 14:27:06 +0200 Subject: [PATCH] Created console.read (markdown) --- console.read.md | 41 +++++++++++++++++++++++++++++++++++++++++ 1 file changed, 41 insertions(+) create mode 100644 console.read.md diff --git a/console.read.md b/console.read.md new file mode 100644 index 0000000..03bcb03 --- /dev/null +++ b/console.read.md @@ -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..." +} +``` \ No newline at end of file