More reference docs

This commit is contained in:
Luke Murphy 2021-01-10 17:00:38 +01:00
parent bfbc180d64
commit 379bf70bbf
No known key found for this signature in database
GPG Key ID: 5E2EF5A63E3718CC

View File

@ -45,7 +45,16 @@ underling functions can be extended. For example, if you want to enable more
plugins or add different functionality. If something feels awkwardthen please plugins or add different functionality. If something feels awkwardthen please
raise a ticket for that. Seamlessness is still a bitch but we're trying anyway. raise a ticket for that. Seamlessness is still a bitch but we're trying anyway.
### send_direct_chat ### Bot.reply_direct_chat
A function which you define in your bot implementation in order to respond to
direct chat messages.
Arguments:
- **message**: sent message and metadata (see [message](#message) reference below)
### Bot.send_direct_chat
Send back a response to a direct chat message. Send back a response to a direct chat message.
@ -54,7 +63,16 @@ Arguments:
- **to**: who to send it to (can be a user or a room) - **to**: who to send it to (can be a user or a room)
- **body**: the message to send - **body**: the message to send
### send_group_chat ## Bot.reply_group_chat
A function which you define in your bot implementation in order to respond to
group chat messages.
Arguments:
- **message**: sent message and metadata (see [message](#message) reference below)
### Bot.send_group_chat
Send back a response to a group chat message. Send back a response to a group chat message.
@ -63,6 +81,18 @@ Arguments:
- **to**: who to send it to (can be a user or a room) - **to**: who to send it to (can be a user or a room)
- **body**: the message to send - **body**: the message to send
### Message
A simple message format.
Attributes:
- **body**
- **sender**
- **receive**
- **nickname**
- **type**
## Roadmap ## Roadmap
- The library only handles reactions. The bots can only send messages when they - The library only handles reactions. The bots can only send messages when they