package
0.0.0-20231022132044-7a6c0c805787
Repository: https://github.com/fishze/go-libonebot.git
Documentation: pkg.go.dev
# Functions
EventCheck 检查事件是否合法
s: Self 自身标识 e: Event 事件 需要满足条件.
GetSegment 返回消息段
Reference: https://12.onebot.dev/glossary/#message-segment-segment.
GetSegmentAudio 返回音频消息段
Reference: https://12.onebot.dev/interface/message/segments/#audio.
GetSegmentFile 返回文件消息段
Reference: https://12.onebot.dev/interface/message/segments/#file.
GetSegmentImage 返回图片消息段
Reference: https://12.onebot.dev/interface/message/segments/#image.
GetSegmentLocation 返回位置消息段
Reference: https://12.onebot.dev/interface/message/segments/#location.
GetSegmentMention 返回@消息段
Reference: https://12.onebot.dev/interface/message/segments/#mention.
GetSegmentMentionAll 返回@全体成员消息段
Reference: https://12.onebot.dev/interface/message/segments/#mention_all.
GetSegmentReply 返回回复消息段
Reference: https://12.onebot.dev/interface/message/segments/#reply.
GetSegmentText 返回文本消息段
Reference: https://12.onebot.dev/interface/message/segments/#text.
GetSegmentVideo 返回视频消息段
Reference: https://12.onebot.dev/interface/message/segments/#video.
GetSegmentVoice 返回语音消息段
Reference: https://12.onebot.dev/interface/message/segments/#voice.
HandleActionDeleteMessage 处理DeleteMessage请求.
HandleActionGetChannelInfo 处理GetChannelInfo请求.
HandleActionGetChannelList 处理GetChannelList请求.
HandleActionGetChannelMemberInfo 处理GetChannelMemberInfo请求.
HandleActionGetChannelMemberList 处理GetChannelMemberList请求.
HandleActionGetFile 处理GetFile请求.
HandleActionGetFileFragmented 处理GetFileFragmented请求.
HandleActionGetFriendList 处理GetFriendList请求.
HandleActionGetGroupInfo 处理GetGroupInfo请求.
HandleActionGetGroupList 处理GetGroupList请求.
HandleActionGetGroupMemberInfo 处理GetGroupMemberInfo请求.
HandleActionGetGroupMemberList 处理GetGroupMemberList请求.
HandleActionGetGuildInfo 处理GetGuildInfo请求.
HandleActionGetGuildList 处理GetGuildList请求.
HandleActionGetGuildMemberInfo 处理GetGuildMemberInfo请求.
HandleActionGetGuildMemberList 处理GetGuildMemberList请求.
HandleActionGetLatestEvents 处理GetLatestEvents请求.
HandleActionGetSelfInfo 处理GetSelfInfo请求.
HandleActionGetStatus 处理GetStatus请求.
HandleActionGetSupportedActions 处理GetSupportedActions请求.
HandleActionGetUserInfo 处理GetUserInfo请求.
HandleActionGetVersion 处理GetVersion请求.
HandleActionLeaveChannel 处理LeaveChannel请求.
HandleActionLeaveGroup 处理LeaveGroup请求.
HandleActionLeaveGuild 处理LeaveGuild请求.
HandleActionSendMessage 处理SendMessage请求.
HandleActionSetChannelName 处理SetChannelName请求.
HandleActionSetGroupName 处理SetGroupName请求.
HandleActionSetGuildName 处理SetGuildName请求.
HandleActionUploadFile 处理UploadFile请求.
HandleActionUploadFileFragmented 处理UploadFileFragmented请求.
NewEmptyResponse 构造函数.
NewMessageEventChannel 创建一个频道消息事件.
NewMessageEventGroup 创建一个群消息事件.
NewMessageEventPrivate 创建一个私聊消息事件.
NewMetaEventConnect 创建一个连接事件.
NewMetaEventHeartbeat 创建一个心跳事件.
NewMetaEventStatusUpdate 创建一个机器人状态更新事件.
NewNoticeEventChannelCreate 创建一个频道创建事件.
NewNoticeEventChannelDelete 创建一个频道删除事件.
NewNoticeEventChannelMemberDecrease 创建一个频道成员减少事件
subType: leave / kick / 自定义 / 空.
NewNoticeEventChannelMemberIncrease 创建一个频道成员增加事件
subType: join / invite / 自定义 / 空.
NewNoticeEventChannelMessageDelete 创建一个消息删除事件
subType: recall / delete / 自定义 / 空.
NewNoticeEventFriendDecrease 创建一个好友减少事件.
NewNoticeEventFriendIncrease 创建一个好友增加事件.
NewNoticeEventGroupMemberDecrease 创建一个群成员减少事件
subType: leave / kick / 自定义 / 空.
NewNoticeEventGroupMemberIncrease 创建一个群成员增加事件
subType: join / invite / 自定义 / 空.
NewNoticeEventGroupMessageDelete 创建一个群消息删除事件
subType: recall / delete / 自定义 / 空.
NewNoticeEventGuildMemberDecrease 创建一个群组成员减少事件
subType: leave / kick / 自定义 / 空.
NewNoticeEventGuildMemberIncrease 创建一个群组成员增加事件
subType: join / invite / 自定义 / 空.
NewNoticeEventMessageDelete 创建一个消息删除事件.
NewResponseDeleteMessage 撤回消息 构造函数.
NewResponseGetChannelInfo 获取频道信息 构造函数.
NewResponseGetChannelList 获取频道列表 构造函数.
NewResponseGetChannelMemberInfo 获取频道成员信息 构造函数.
NewResponseGetChannelMemberList 获取频道成员列表 构造函数.
NewResponseGetFile 获取文件 构造函数.
NewResponseGetFileFragmentedStart 获取分片文件 构造函数.
NewResponseGetFriendList 获取好友列表 构造函数.
NewResponseGetGroupInfo 获取群信息 构造函数.
NewResponseGetGroupList 获取群列表 构造函数.
NewResponseGetGroupMemberInfo 获取群成员信息 构造函数.
NewResponseGetGroupMemberList 获取群成员列表 构造函数.
NewResponseGetGuildInfo 获取群组信 构造函数.
NewResponseGetGuildList 获取群组列表 构造函数.
NewResponseGetGuildMemberInfo 获取群组成员信息 构造函数.
NewResponseGetGuildMemberList 获取群组成员列表 构造函数.
NewResponseGetLatestEvents 获取最近的事件 构造函数.
NewResponseGetSelfInfo 获取机器人自身信息.
NewResponseGetStatus 获取运行状态 构造函数.
NewResponseGetSupportedActions 获取支持的动作列表 构造函数.
NewResponseGetUserInfo 获取用户信息 构造函数.
NewResponseGetVersion 获取版本信息 构造函数.
NewResponseLeaveChannel 退出频道 构造函数.
NewResponseLeaveGroup 退群 构造函数.
NewResponseLeaveGuild 退群组 构造函数.
NewResponseSendMessage 发送消息 构造函数
已经帮你生成好了MessageID和Time 直接返回就行.
NewResponseSetChannelName 设置频道名称 构造函数.
NewResponseSetGroupName 设置群名称 构造函数.
NewResponseSetGuildName 设置群组名称 构造函数.
NewResponseUploadFile 上传文件 构造函数.
NewResponseUploadFileFragmentedStart 上传分片文件 构造函数.
RequestAdapter 将RawRequestType转换为Request.
ResponseCheck 检查响应是否合法.
# Constants
EventTypeMessage 消息事件.
EventTypeMeta 元事件.
EventTypeNotice 通知事件.
EventTypeRequest 请求事件.
ResponseCodeBadHandler 动作处理器实现错误 没有正确设置响应状态等.
ResponseCodeBadParam 无效的动作请求参数 参数缺失或参数类型错误.
ResponseCodeBadRequest 无效的动作请求 格式错误(包括实现不支持 MessagePack 的情况)、必要字段缺失或字段类型错误.
ResponseCodeBadSegmentData 无效的消息段参数 参数缺失或参数类型错误.
ResponseCodeInternalHandlerError 动作处理器运行时抛出异常 OneBot 实现内部发生了未捕获的意料之外的异常.
ResponseCodeOk 请求成功 当动作请求有效、动作执行成功时,返回码应为 0。.
ResponseCodeUnknownSelf 未知的机器人账号 动作请求指定的机器人账号不存在.
ResponseCodeUnsupportedAction 不支持的动作请求 OneBot 实现没有实现该动作.
ResponseCodeUnsupportedParam 不支持的动作请求参数 OneBot 实现没有实现该参数的语义.
ResponseCodeUnsupportedSegment 不支持的消息段类型 OneBot 实现没有实现该消息段类型.
ResponseCodeUnsupportedSegmentData 不支持的消息段参数 OneBot 实现没有实现该参数的语义.
ResponseCodeWhoAmI 未指定机器人账号 OneBot 实现在单个 OneBot Connect 连接上支持多个机器人账号,但动作请求未指定要使用的账号.
StatusFailed 失败.
StatusOk 正常.
# Variables
ErrorActionEmpty 动作为空.
ErrorInvalidEvent 该结构体不是一个OneBot事件.
ErrorInValidEventType 事件类型无效.
ErrorInvalidRequest 该结构体不是一个OneBot事件.
ErrorInvalidResponse 该结构体不是一个OneBot动作相应.
ErrorInvalidResponseRetCode 返回码无效.
ErrorRequestIsNil 请求为空.
ErrorRequestNotMatch 请求不匹配.
EventType 事件类型.
RequestType 事件类型.
ResponseType 事件类型.
# Structs
EmptyResponse 空响应.
Event 事件
Reference: https://12.onebot.dev/connect/data-protocol/event/.
MessageEventChannel 频道消息事件
Reference: https://12.onebot.dev/interface/guild/message-events/#messagechannel.
MessageEventGroup 群消息事件
Reference: https://12.onebot.dev/interface/group/message-events/#messagegroup.
MessageEventPrivate 私聊消息事件
Reference: https://12.onebot.dev/interface/user/message-events/#messageprivate.
MetaEventConnect 连接事件
Reference: https://12.onebot.dev/interface/meta/events/#metaconnect.
MetaEventHeartbeat 心跳事件.
MetaEventStatusUpdate 机器人状态更新事件
Reference: https://12.onebot.dev/interface/meta/events/#metastatus_update.
NoticeEventChannelCreate 频道创建事件
Reference: https://12.onebot.dev/interface/guild/notice-events/#noticechannel_create.
NoticeEventChannelDelete 频道删除事件
Reference: https://12.onebot.dev/interface/guild/notice-events/#noticechannel_delete.
NoticeEventChannelMemberDecrease 频道成员减少事件
Reference: https://12.onebot.dev/interface/guild/notice-events/#noticechannel_member_decrease.
NoticeEventChannelMemberIncrease 频道成员增加事件
Reference: https://12.onebot.dev/interface/guild/notice-events/#noticechannel_member_increase.
NoticeEventChannelMessageDelete 消息删除事件
Reference: https://12.onebot.dev/interface/guild/notice-events/#noticechannel_message_delete.
NoticeEventFriendDecrease 好友减少事件
Reference: https://12.onebot.dev/interface/user/notice-events/#noticefriend_decrease.
NoticeEventFriendIncrease 好友增加事件
Reference: https://12.onebot.dev/interface/user/notice-events/#noticefriend_increase.
NoticeEventGroupMemberDecrease 群成员减少事件
Reference: https://12.onebot.dev/interface/group/notice-events/#noticegroup_member_decrease.
NoticeEventGroupMemberIncrease 群成员增加事件
Reference: https://12.onebot.dev/interface/group/notice-events/#noticegroup_member_increase.
NoticeEventGroupMessageDelete 消息删除事件
Reference: https://12.onebot.dev/interface/group/notice-events/#noticegroup_message_delete.
NoticeEventGuildMemberDecrease 群组成员减少事件
Reference: https://12.onebot.dev/interface/guild/notice-events/#noticeguild_member_decrease.
NoticeEventGuildMemberIncrease 群组成员增加事件
Reference: https://12.onebot.dev/interface/guild/notice-events/#noticeguild_member_increase.
NoticeEventMessageDelete 消息删除事件
Reference: https://12.onebot.dev/interface/user/notice-events/#noticeprivate_message_delete.
OneBotConfig OneBot协议配置.
RawRequestType 最原始的动作请求, 用于兼容和各种连接交互.
Request 动作请求.
RequestDeleteMessage 撤回消息
Reference: https://12.onebot.dev/interface/message/actions/#delete_message.
RequestGetChannelInfo 获取频道信息
Reference: https://12.onebot.dev/interface/guild/actions/#get_channel_info.
RequestGetChannelList 获取频道列表
Reference: https://12.onebot.dev/interface/guild/actions/#get_channel_list.
RequestGetChannelMemberInfo 获取频道成员信息
Reference: https://12.onebot.dev/interface/guild/actions/#get_channel_member_info.
RequestGetChannelMemberList 获取频道成员列表
Reference: https://12.onebot.dev/interface/guild/actions/#get_channel_member_list.
RequestGetFile 获取文件
Reference: https://12.onebot.dev/interface/file/actions/#get_file.
RequestGetFileFragmented 获取文件分片
Reference: https://12.onebot.dev/interface/file/actions/#get_file_fragmented.
RequestGetFriendList 获取好友列表
获取机器人的关注者或好友列表。
Reference: https://12.onebot.dev/interface/user/actions/#get_friend_list.
RequestGetGroupInfo 获取群信息
Reference: https://12.onebot.dev/interface/group/actions/#get_group_info.
RequestGetGroupList 获取群列表
Reference: https://12.onebot.dev/interface/group/actions/#get_group_list.
RequestGetGroupMemberInfo 获取群成员信息
Reference: https://12.onebot.dev/interface/group/actions/#get_group_member_info.
RequestGetGroupMemberList 获取群成员列表
Reference: https://12.onebot.dev/interface/group/actions/#get_group_member_list.
RequestGetGuildInfo 获取群组信息
Reference: https://12.onebot.dev/interface/guild/actions/#get_guild_info.
RequestGetGuildList 获取群组列表
Reference: https://12.onebot.dev/interface/guild/actions/#get_guild_list.
RequestGetGuildMemberInfo 获取群组成员信息
Reference: https://12.onebot.dev/interface/guild/actions/#get_guild_member_info.
RequestGetGuildMemberList 获取群组成员列表
Reference: https://12.onebot.dev/interface/guild/actions/#get_guild_member_list.
RequestGetLatestEvents 获取最新事件列表
仅 HTTP 通信方式必须支持,用于轮询获取事件。
Reference: https://12.onebot.dev/interface/meta/actions/#get_latest_events.
RequestGetSelfInfo 获取机器人自身信息
Reference: https://12.onebot.dev/interface/user/actions/#get_self_info.
RequestGetStatus 获取运行状态
Reference: https://12.onebot.dev/interface/meta/actions/#get_status.
RequestGetSupportedActions 获取支持的动作列表
Reference: https://12.onebot.dev/interface/meta/actions/#get_supported_actions.
RequestGetUserInfo 获取用户信息
Reference: https://12.onebot.dev/interface/user/actions/#get_user_info.
RequestGetVersion 获取版本信息
Reference: https://12.onebot.dev/interface/meta/actions/#get_version.
RequestLeaveChannel 离开频道
Reference: https://12.onebot.dev/interface/guild/actions/#leave_channel.
RequestLeaveGroup 退出群
Reference: https://12.onebot.dev/interface/group/actions/#leave_group.
RequestLeaveGuild 退出群组
Reference: https://12.onebot.dev/interface/guild/actions/#leave_guild.
RequestSendMessage 发送消息
对于不同平台的 detail_type,如果符合标准所定义的类型,如私聊对应 private、群组对应 group,则建议使用标准定义的 detail_type 和 xxx_id。
对于其它具体类型,例如过去 QQ 还存在讨论组的情况,可以指定 detail_type 为 qq.discuss,然后参数使用 qq.discuss_id 指示讨论组 ID。
更多详细扩展规则请参考 扩展规则 https://12.onebot.dev/interface/rules/。
Reference: https://12.onebot.dev/interface/message/actions/#send_message.
RequestSetChannelName 设置频道名称
Reference: https://12.onebot.dev/interface/guild/actions/#set_channel_name.
RequestSetGroupName 设置群名称
Reference: https://12.onebot.dev/interface/group/actions/#set_group_name.
RequestSetGuildName 设置群组名称
Reference: https://12.onebot.dev/interface/guild/actions/#set_guild_name.
RequestUploadFile 上传文件
Reference: https://12.onebot.dev/interface/file/actions/#upload_file.
RequestUploadFileFragmented 上传文件分片
Reference: https://12.onebot.dev/interface/file/actions/#upload_file_fragmented.
Response 动作响应 Reference: https://12.onebot.dev/connect/data-protocol/action-response/.
ResponseDeleteMessage 撤回消息
Reference: https://12.onebot.dev/interface/message/actions/#delete_message
空的.
ResponseGetChannelInfo 获取频道信息
Reference: https://12.onebot.dev/interface/guild/actions/#get_channel_info.
ResponseGetChannelList 获取频道列表
Reference: https://12.onebot.dev/interface/guild/actions/#get_channel_list.
ResponseGetChannelMemberInfo 获取频道成员信息
Reference: https://12.onebot.dev/interface/guild/actions/#get_channel_member_info.
ResponseGetChannelMemberList 获取频道成员列表
Reference: https://12.onebot.dev/interface/guild/actions/#get_channel_member_list.
ResponseGetFile 获取文件
Reference: https://12.onebot.dev/interface/file/actions/#get_file
这里虽然说“必须返回”,但如果平台真的无法获得 URL,当用户请求 type 为 url 时,可以返回 10004 Unsupported Param。具体见 接口定义 - 概述 中对 OneBot 实现的要求。.
ResponseGetFileFragmented 获取分片文件
Reference: https://12.onebot.dev/interface/file/actions/#get_file_fragmented.
ResponseGetFriendList 获取好友列表
Reference: https://12.onebot.dev/interface/user/actions/#get_friend_list.
ResponseGetGroupInfo 获取群信息
Reference: https://12.onebot.dev/interface/group/actions/#get_group_info.
ResponseGetGroupList 获取群列表
Reference: https://12.onebot.dev/interface/group/actions/#get_group_list.
ResponseGetGroupMemberInfo 获取群成员信息
Reference: https://12.onebot.dev/interface/group/actions/#get_group_member_info.
ResponseGetGroupMemberList 获取群成员列表
Reference: https://12.onebot.dev/interface/group/actions/#get_group_member_list.
ResponseGetGuildInfo 获取群组信
Reference: https://12.onebot.dev/interface/guild/actions/#get_guild_info.
ResponseGetGuildList 获取群组列表
获取机器人加入的群组列表。
Reference: https://12.onebot.dev/interface/guild/actions/#get_guild_list.
ResponseGetGuildMemberInfo 获取群组成员信息
Reference: https://12.onebot.dev/interface/guild/actions/#get_guild_member_info.
ResponseGetGuildMemberList 获取群组成员列表
Reference: https://12.onebot.dev/interface/guild/actions/#get_guild_member_list.
ResponseGetLatestEvents 获取最近的事件.
ResponseGetSelfInfo 获取机器人自身信息
Reference: https://12.onebot.dev/interface/user/actions/#get_self_info.
ResponseGetStatus 获取运行状态
Reference: https://12.onebot.dev/interface/meta/actions/#get_status.
ResponseGetSupportedActions 获取支持的动作列表
Reference: https://12.onebot.dev/interface/meta/actions/#get_supported_actions.
ResponseGetUserInfo 获取用户信息
Reference: https://12.onebot.dev/interface/user/actions/#get_user_info.
ResponseGetVersion 获取版本信息
Reference: https://12.onebot.dev/interface/meta/actions/#get_version.
ResponseLeaveChannel 退出频道
Reference: https://12.onebot.dev/interface/guild/actions/#leave_channel.
ResponseLeaveGroup 退群
Reference: https://12.onebot.dev/interface/group/actions/#leave_group
空的.
ResponseLeaveGuild 退群组
Reference: https://12.onebot.dev/interface/guild/actions/#leave_guild.
ResponseSendMessage 发送消息
Reference: https://12.onebot.dev/interface/message/actions/#send_message.
ResponseSetChannelName 设置频道名称
Reference: https://12.onebot.dev/interface/guild/actions/#set_channel_name.
ResponseSetGroupName 设置群名称
Reference: https://12.onebot.dev/interface/group/actions/#set_group_name
空的.
ResponseSetGuildName 设置群组名称
Reference: https://12.onebot.dev/interface/guild/actions/#set_guild_name.
ResponseUploadFile 上传文件
Reference: https://12.onebot.dev/interface/file/actions/#upload_file.
ResponseUploadFileFragmented 上传分片文件
Reference: https://12.onebot.dev/interface/file/actions/#upload_file_fragmented.
Segment 消息段
Reference: https://12.onebot.dev/glossary/#message-segment-segment.
Self 字段 用于区分不同机器人.
# Interfaces
RequestInterface 动作请求接口.