mrtoth/frontend-tutorial-framework
1
0
Fork 0
mirror of https://github.com/avatao-content/frontend-tutorial-framework synced 2025-04-03 11:52:40 +00:00
Code Issues Releases Wiki Activity

Update documentation with message queueing stuff

Browse Source
This commit is contained in:
Kristóf Tóth 2018-06-26 16:04:09 +02:00
parent 958b44e570
commit ea5ed41485
1 changed files with 29 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

30
README.md
View File

@ -97,12 +97,40 @@ The message format used:
"data": "data":
{ {
"originator": ..., "originator": ...,
"timestamp": ...,
"message": ... "message": ...
} }
} }
``` ```
This component can be used as a simple chatbot as well.
You can provide a list of messages to queue and they will be automatically displayed one after the other.
There is a wait time between each message so that the user can properly read them.
This wait time is calculated from the length of the last message, and can be configured using the `messages.messageQueueWPM` key in `config.ts`.
You can queue messages like so:
```
{
"key": "queueMessages",
"data":
{
"messages":
[
{
"originator": ...
"message": ...
},
{
"originator": ...
"message": ...
},
...
]
}
}
```
You can use the `MessageSender` class to send messages from the TFW server or event handlers written in Python. You can use the `MessageSender` class to send messages from the TFW server or event handlers written in Python.
### Web – customisable component ### Web – customisable component