动作¶

这个类封装了大部分webapi, 并添加了部分常用方法

初始化¶

from iotbot import Action

action = Action(123456)
'''
必选参数：
qq_or_bot: qq 号或者机器人实例(`IOTBOT`), 如果传入机器人实例，如果开启多Q，将选取第一个 QQ

可选参数:
与发送队列有关的参数:
queue: 队列开关
queue_delay: 队列延时
------
timeout: 发送请求等待响应的时间
api_path:
port:
host:
'''

每个方法有完善的代码提示，参数命名也对应原 api 数据命名，所以不说明了。对于参数的疑问请先查询 iotqq 提供 webapi 文档如果还有疑问，请查看源码

Action.baseSender¶

所有方法调用这个基础方法

开放出来是因为有时候出了新功能，可以用这个自行构建请求。参数：

method: 请求方法, 如 POST、GET
funcname: 请求类型, 即 iotbot webapi 路径中的参数
data: post 的数据, 不需要就不传
timeout: 发送请求等待响应的时间(requests)
api_path: 默认为/v1/LuaApiCaller
iot_timeout: IOT 端处理请求等待的时间, 即 iotbot webapi 路径中的参数, 具体意思自行去机器人框架了解
bot_qq: 机器人 QQ

方法一览¶

表格显示不出可以直接在 github 上看

发送队列¶

发送过快会导致发送失败或消息被 tx 屏蔽, 所以某些情况很有必要开启，特别是发图

初始化Action时设置参数queue为True即可以队列的方式执行发送任务，开启后对应有两个参数可以设置

queue_delay 队列每一次发送之间的延时，一般保持默认即可，这是群内大佬的经验数值

注意:

开启队列后方法都没有返回值，所以只适合执行发送任务。

(v2.4.0 增加)在使用开启队列的 action 运行各种方法时，可指定关键字参数callback, callback 要求为一个函数，函数有且只能有一个参数，之后会自动将队列中任务的返回值传说 callback 执行

没有对不同的群和 api 进行分开发送，即所有操作都会排入队列中, 这样也符合真人行为(个人觉得)

Action 必须定义为全局变量，不能放在接收函数内,这个其实不应该说明的，因为放在函数内会导致的问题显而易见
参考bot_test_queue

sugar¶

在 action 的基础上深度封装了常用操作, 适用于简单的场景，不支持队列发送使用的前提是使用默认的端口和 ip 配置或者已经设置好文件.iotbot.json，这个是什么在配置章节介绍

from iotbot.sugar import Text, Picture, Voice, Send

Text('Hello') # 对该消息的来源(群或好友),发送内容为Hello的文字消息
Picture(pic_url='') # 同上，这里是发送图片消息
Voice(...)
...

调用这几个方法，会自动选择上下文对进行不同的回复，包括临时会话

具体参数看代码提示, 如果提示不全请看源码注释!

这几个函数只能在群消息和好友消息接收函数中使用

Tips¶

因为 Action 和 IOTBOT 实例完全解耦，所以你可以在自己的脚本中使用，比如用这个替代 shell 替代定时脚本