diff --git a/message.send.md b/message.send.md new file mode 100644 index 0000000..ea18ca9 --- /dev/null +++ b/message.send.md @@ -0,0 +1,28 @@ +* **Description**: Sends a message to the chat bot. +* **Subscribers**: [FrontendProxyHandler](https://github.com/avatao-content/baseimage-tutorial-framework/wiki/FrontendProxyHandler) + +```json +{ + "key": "message.send", + "intent": "control", + "scope": "websocket" +} +``` + +| Parameter | Type | Required | Description | +| ------------ |:--------:|:------------------:| --------------------------- | +| *message* | `string` | :heavy_check_mark: | Body of the message, should be Markdown compatible. | +| *originator* | `string` | | Name of the sender. | +| *wpm* | `number` | | Tunes typing speed based on words per minute. | +| *typing* | `boolean` | | Displays typing indicator when true. | + +*** + +**Example**: +```json +{ + "key": "message.send", + "originator": "Brian Kernighan", + "message": "hello, world" +} +``` \ No newline at end of file