机器人 API
Connect connect = new("localhost", 3001, 3000);
Bot bot = new(connect);
名称 | 类型 | 使用 | 参数 | 说明 |
---|
好友 | 属性 | bot.Friends | 无 | 无 |
群 | 属性 | bot.Groups | 无 | 无 |
onebot版本 | 属性 | bot.Version | 无 | 无 |
onebot状态 | 属性 | bot.Status | 无 | 无 |
检查是否可以发送语音 | 方法 | bot.CanSendRecord | 无 | 无 |
检查是否可以发送图片 | 方法 | bot.CanSendImage | 无 | 无 |
重启 | 方法 | bot.Restart | delay:延迟重启 | 无 |
发送私聊消息 | 方法 | bot.SendPrivateMessage | qq/friend:qq号/好友对象;msg:消息内容 | 存在重载,自行查看 |
发送群聊消息 | 方法 | bot.SendGroupMessage | groupQQ/group:qq群号/群对象;msg:消息内容 | 存在重载,自行查看 |
扩展api方法 | 方法 | bot.GetAsync | apiEndpoint:请求端点;paramStr:请求参数字符串(url格式拼接好) | onebot实现框架的扩展api通用调用方法;存在重载,自行查看 |
扩展api方法 | 方法 | bot.PostAsync | apiEndpoint:请求端点;data:请求body数据(json字符串) | onebot实现框架的扩展api通用调用方法;存在重载,自行查看 |
资源释放 | 方法 | bot.Dispose | 无 | 无 |
群聊对象
bot.MessageReceived.OfType<GroupReceiver>().Subscribe(gr =>
{
});
名称 | 类型 | 使用 | 参数 | 说明 |
---|
群消息 | 属性 | gr.Group | 无 | 群对象 |
发送消息 | 方法 | gr.SendMessage | msg:消息内容 | 存在重载,自行查看 |
撤回消息 | 方法 | gr.Recall | 无 | 无 |
群对象
Connect connect = new("localhost", 3001, 3000);
Bot bot = new(connect);
var group = bot.Groups[0];
名称 | 类型 | 使用 | 参数 | 说明 |
---|
群成员列表 | 属性 | group.Members | 无 | 群成员对象 |
群荣誉 | 属性 | group.Honor | 无 | 无 |
发送消息 | 方法 | group.SendMessage | msg:消息内容 | 存在重载,自行查看 |
全体禁言 | 方法 | group.EnableGroupBan | 无 | 无 |
取消全体禁言 | 方法 | group.DisableGroupBan | 无 | 无 |
允许匿名聊天 | 方法 | group.EnableAnonymous | 无 | 无 |
禁止匿名聊天 | 方法 | group.DisableAnonymous | 无 | 无 |
设置群名 | 方法 | group.SetGroupName | name:新群名 | 无 |
退出群聊 | 方法 | group.LeaveGroup | dissolve:是否解散,如果登录号是群主,则仅在此项为 true 时能够解散 | 无 |
群成员对象
Connect connect = new("localhost", 3001, 3000);
Bot bot = new(connect);
var member = bot.Groups[0].Members[0];
名称 | 类型 | 使用 | 参数 | 说明 |
---|
设置群组专属头衔 | 方法 | member.SetTitle | title:专属头衔,不填或空字符串表示删除专属头衔;time:专属头衔有效期,单位秒,-1表示永久 | 无 |
成员在群的昵称 | 方法 | member.SetNickname | name:成员在群的昵称,不填或空字符串表示删除昵称,使用qq昵称 | 无 |
任命管理 | 方法 | member.SetAdmin | 无 | 无 |
卸任管理 | 方法 | member.RemoveAdmin | 无 | 无 |
禁言 | 方法 | member.Ban | time?:禁言时间,单位秒 | 无 |
取消禁言 | 方法 | member.CancelBan | 无 | 无 |
踢出群聊 | 方法 | member.Kick | reject?:拒绝此人的加群请求 | 无 |
点赞 | 方法 | member.Like | times?:次数 | 非好友可能操作失败 |
发送消息 | 方法 | member.SendMessage | msg:消息内容 | 非好友大概率发送失败;存在重载 |
好友对象
Connect connect = new("localhost", 3001, 3000);
Bot bot = new(connect);
var friend = bot.Friends[0];
名称 | 类型 | 使用 | 参数 | 说明 |
---|
发送消息 | 方法 | group.SendMessage | msg:消息内容 | 存在重载,自行查看 |
点赞 | 方法 | group.Like | times?:次数 | 存在重载,自行查看 |
框架扩展 API
onebot 机器人实现框架会有一些自己的 API(非 onebot 标准),此框架由于是按照 onebot 标准实现的,所以不提供也不会支持这些扩展 api 的使用方法,不过可以通过此框架的扩展 api 方法调用到这些 API。例如:
//例如框架扩展的api是upload_file,接口返回值假设是FileInfo类,需要传入path参数,则调用方法如下
bot.GetAsync("upload_file","?path=xxxxx");
bot.GetAsync<FileInfo>("upload_file","?path=xxxxx");
bot.PostAsync("upload_file",new {path="xxx"}.ToJsonStr());
bot.PostAsync<FileInfo>("upload_file",new {path="xxx"}.ToJsonStr());