服务器监控 Discord Bot 的 API 包
项目描述
服务器监控 Discord bot API
仅当在其上启用 API 时，此 API 才能用于与服务器监控 Discord bot 交互。为此，机器人需要在同一台 PC 上运行，或者需要设置 API 以允许外部连接。
用法
要创建 api，请导入包并使用所需的参数。
import smdb_api
API = smdb_api.API("Test", "80716cbfd9f90428cd308acc193b4b58519a4f10a7440b97aaffecf75e63ecec")
可用参数：
- 名称：字符串 | 用于向 api 服务器标识应用程序。
- 键：字符串 | 用于与 api 服务器验证身份。
- ip：字符串（可选）| 用于设置 api 服务器的 IP 地址。
- 端口：整数（可选）| 用于设置api服务器的监听端口。
- update_function：函数（可选）| 当 api 服务器更新时，设置要调用的回调函数。
要启动连接，请使用 validate 命令。validate 函数可以获得超时限制，因此如果 api 服务器在设定的时间内没有响应，它不会拖拽程序。
API.validate()
server_status = API.get_status()
要将命令添加到机器人，请使用“create_function”命令，如下所示：
[...]
def my_callback(message):
#Does something
API.create_function("MyScript", "Some text to help\nUsage: &MyScript <User input>\nCategory: SERVER", my_callback)
要向某人发送消息，请使用“send_message”命令：
[...]
discordId="##################"
API.send_message("Test message to a channel", discordId)
print(f"I sent a message to {API.get_username(discordId)}!")
使用“关闭”命令可以轻松安全地关闭连接。
[...]
API.close("Some reason for the bot logger.")
可用命令
证实
此函数连接到 API 服务器并使用它验证自己。如果验证成功，它会启动一个侦听器线程。
获取状态
此函数检索机器人的状态并将其返回到字典中。
获取用户名
此命令返回给定 Discord ID 的用户名。
is_admin
确定用户是否是机器人数据库中的管理员。
发信息
此命令允许您以机器人的名称向选定的用户/频道或默认频道发送消息。
创建函数
此命令在机器人中创建一个可由用户调用的函数。
connect_to_voice
此命令将客户端连接到用户的语音通道
disconnect_from_voice
此命令断开客户端与用户语音通道的连接
播放文件
在提供的路径上启动音频文件。如果文件不受支持，则返回错误。
添加文件
将音频文件添加到提供的路径上的播放列表中。如果文件不受支持，则返回错误。
pause_currently_playing
暂停当前播放的曲目。
resume_paused
恢复播放暂停的曲目。
跳过当前播放
如果播放列表中有其他曲目，则跳过当前曲目。
停止当前播放
停止当前播放的曲目。
获取队列
列出播放列表中项目的名称，从当前播放的文件开始。
set_as_hook_for_track_finished
设置当前大头钉完成播放以可能删除文件时的回调。
下载文件
下载适用于您平台的文件。如果您不确定要选择哪个，请了解有关安装包的更多信息。
源分布
smdb_api-0.8.3.tar.gz
（8.5 kB
查看哈希）
内置分布
smdb_api-0.8.3-py3-none-any.whl
（10.3 kB
查看哈希）