mrkrk/boticordpy
1
0
Fork 0
mirror of https://github.com/boticord/boticordpy.git synced 2024-09-22 19:32:01 +03:00
Code Issues Projects Releases Packages Wiki Activity Actions

update docs

Browse source
This commit is contained in:
Victor Kotlin 2021-09-12 13:32:06 +03:00
parent d5f1e27cbc
commit 1aab7f3fcb
1 changed files with 65 additions and 39 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

104
docs/reference.rst
View file

@ -32,52 +32,78 @@ You can name the function whatever you want, but the decorator must always speci
errors. In order to turn a function into a coroutine they must be ``async def`` errors. In order to turn a function into a coroutine they must be ``async def``
functions. functions.
.. function:: new_bot_bump **new_bot_bump**
Called when the user bumps the bot. Called when the user bumps the bot.
Return Example: ``{type': 'new_bot_bump', Return Example:
'data': {
'user': '809377165534822410',
'at': 1631436624444}
}``
.. function:: new_bot_comment ::
Called when the user creates new comment.
Return Example: ``{'type': 'new_bot_comment',
'data': {
'user': '704373738086465607',
'comment': {
'old': None,
'new': 'boticord po jizni top'},
'at': 1631439995678}
}``
.. function:: edit_bot_comment {type': 'new_bot_bump',
'data': {
'user': '809377165534822410',
'at': 1631436624444
}
}
Called when the user edits his comment. **new_bot_comment**
Return Example: ``{ Called when the user creates new comment.
'type': 'edit_bot_comment',
'data': {
'user': '585766846268047370',
'comment': {
'old': 'Boticord eto horosho',
'new': 'Boticord horoshiy monitoring'},
'at': 1631438224813}}``
.. function:: delete_bot_comment Return Example:
Called when the user deletes his comment. ::
Return Example: ``{
'type': 'delete_bot_comment', {'type': 'new_bot_comment',
'data': { 'data': {
'user': '704373738086465607', 'user': '704373738086465607',
'comment': 'допустим что я картофель', 'comment': {
'vote': 1, 'old': None,
'reason': 'self', 'new': 'boticord po jizni top'
'at': 1631439759384}} },
'at': 1631439995678
}
}
**edit_bot_comment**
Called when the user edits his comment.
Return Example:
::
{
'type': 'edit_bot_comment',
'data': {
'user': '585766846268047370',
'comment': {
'old': 'Boticord eto horosho',
'new': 'Boticord horoshiy monitoring'
},
'at': 1631438224813
}
}
**delete_bot_comment**
Called when the user deletes his comment.
Return Example:
::
{
'type': 'delete_bot_comment',
'data': {
'user': '704373738086465607',
'comment': 'допустим что я картофель',
'vote': 1,
'reason': 'self',
'at': 1631439759384
}
}