From 64152fe7d8c57ac140b31e61d599a22ac0eadd8d Mon Sep 17 00:00:00 2001 From: randogoth Date: Fri, 19 May 2023 11:13:16 +0300 Subject: [PATCH] msg obj --- README.md | 11 ++++++++++- 1 file changed, 10 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 715b7b1..cd9a06a 100644 --- a/README.md +++ b/README.md @@ -12,9 +12,18 @@ $ pip install -r requirements.txt - Instantiate the class with a name for the bot as parameter - Use the `received` decorator to define functions for parsing received messages -- Use the `send(recipient_hash, message)` or `reply(message)` methods to send messages +- Use the `.send(recipient_hash, message)` or `msg.reply(message)` methods to send messages - Launch the bot using the `run` method +## Message Object + +Functions decorated by `received` have access to a `msg` parameter that has the following content: + +- `msg.sender` : the sender hash address +- `msg.content`: the received message as utf-8 string +- `msg.reply` : function that takes a string parameter and sends it as reply to the sender +- `msg.lxmf` : the complete `LXMessage` object for more complex parsing + Example of a bot that echos a message back to the sender: ```Python