archfan7411/discordmt
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Add documentation for discord.send param #2

Browse Source
This commit is contained in:
archfan 2019-08-27 11:37:41 -04:00 committed by GitHub
parent 7cb846bf1e
commit 437976b7d9
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 3 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
API.md
View File

@ -4,9 +4,10 @@
It does not expose the command interface or logins to the API, and `discord.register_on_message` events will *not* recieve login information.
### `discord.send(message)`
### `discord.send(message [, optional id])`
Sends `message` to Discord.
This function makes an HTTP request; therefore the sending of large volumes of data might be better grouped into a single request. **Do note that Discord limits messages to 2,000 characters, and the relay automatically cuts off messages.**
The optional `id` parameter specifies a specific Discord user to send the message to.
### `discord.register_on_message(function(name, message))`
Adds a function to `discord.registered_on_messages`, which are called every time a message is received from Discord, excluding logins. `name` is by default the Discord username of the user who sent the message (excluding the discriminator) and `message` is the message content. This function should be called on startup.