Noi/RegexBot
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Updated example

Browse source
This commit is contained in:
Noikoio 2018-04-06 12:51:30 -07:00
parent 1ecf756c06
commit 746219d47d
1 changed files with 3 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
docs/modlogs.md
View file

@ -7,7 +7,7 @@ Sample within a [server definition](serverdef.html):
``` ```
"ModLogs": { "ModLogs": {
"AutoReporting": { "AutoReporting": {
"Channel": "#99999999:mod-events", "WebhookUrl": "https://discordapp.com/api/webhooks/00000/example-aaa000",
"Events": "msgedit,msgdelete", "Events": "msgedit,msgdelete",
"CacheIgnore": 1230000000000 "CacheIgnore": 1230000000000
} }
@ -27,8 +27,8 @@ As its name implies, the `AutoReporting` section allows the bot operator to conf
The following values are accepted within this object: The following values are accepted within this object:
* WebhookUrl (*string*) - **Required.** A webhook URL to be used by the bot for sending events. * WebhookUrl (*string*) - **Required.** A webhook URL to be used by the bot for sending events.
* Events (*string*) - **Required** at the moment. A comma-separated list of event types to be sent to the reporting channel. * Events (*string*) - **Required** at the moment. A comma-separated list of event types to be sent to the reporting channel.
* CacheIgnore (*number*) - Channel (ID) to ignore for MsgEdit and MsgDelete autoreporting. (Optional.) * CacheIgnore (*number*) - Optional. The channel (ID only) in which to ignore reporting of MsgEdit and MsgDelete logs.
* It is **highly recommended** that the reporting channel be specified, otherwise deleting a report within it will cause another report to appear. * It is **highly recommended** that the reporting channel be specified here, otherwise deleting a report within it will cause another report to appear in response.
#### Event types #### Event types
All events fall into one of a number of categories. All events fall into one of a number of categories.