# 返回值
>[info] 本章节将会列举`GETTER`章节中所有的API的返回值对象的含义及其可以获取到的信息。
<hr>
一般情况下,类型为`xxxxList`这种,即返回值为列表的封装类,都会有一个内部类来作为列表中的单个元素。
从`0.9.01-BETA`版本开始,这种`xxxxList`类型的返回值封装类实现了JDK自带的迭代器接口`Iterable` 和默认的实现方法`Stream<T> stream()`,你现在可以更加灵活的操作这些返回值了。
*以下返回值的类型顺序与`GETTER`中的API介绍顺序相同。*
>[info] 以下接口文档基于早期的初版核心,类型并未变更,但是实际方法**请以具体代码为主。**
### **AnonInfo**
>[success] 匿名信息
| 方法 | 返回值类型 | 含义 |
| --- | --- | --- |
| `String getId()` | `String` | 获取ID,一般为匿名信息的标识 |
| `String getAnonName()` | `String` | 获取匿名名称 |
| `String token()` | `String` | 获取token |
<br>
### **AuthInfo**
>[success] 权限信息
| 方法 | 返回值类型 | 含义 |
| --- | --- | --- |
| `String getCode()` | `String` | 获取一个编码 |
| `String getCookies()` | `String` | 获取cookies信息 |
| `String getCsrfToken()` | `String` | 获取CsrfToken |
<br>
### **BanList**
>[success] 禁言列表
| 方法 | 返回值类型 | 含义 |
| --- | --- | --- |
| `BanInfo[] getList()` | `BanInfo[]` | 获取禁言列表 |
* **BanInfo**
**禁言详细信息**
| 方法 | 返回值类型 | 含义 |
| --- | --- | --- |
| `String getQQ()` | `String` | 被禁言者的QQ |
| `String getNickName()` | `String` | 被禁言成员昵称 |
| `Boolean isManager()` | `Boolean` | 是否为管理员 |
| `Long lastTime()` | `Long` | 禁言剩余时间 |
<br>
### **FileInfo**
>[success] 群文件信息
| 方法 | 返回值类型 | 含义 |
| --- | --- | --- |
| `String getFileName()` | `String` | 获取文件名称 |
| `String getId()` | `String` | 文件ID |
| `String getBusid()` | `String` | 文件BUSID |
| `Long getFileSize()` | `Long` | 获取文件大小-字节 |
<br>
### **FriendList**
>[success] 好友列表
| 方法 | 返回值类型 | 含义 |
| --- | --- | --- |
| `Map<String, Friend[]> getFriendList()` | `Map<String, Friend[]>` | 各个分组下的好友列表 |
| `Friend[] getFirendList(String group)` | `Friend[]` | 通过某个分组获取其中的好友列表 |
* **Friend**
**好友信息**
| 方法 | 返回值类型 | 含义 |
| --- | --- | --- |
| `String getName()` | `String` | 获取好友昵称 |
| `String getQQ()` | `String` | 获取好友QQ号 |
<br>
### **GroupHomeworkList**
>[success] 群作业列表
| 方法 | 返回值类型 | 含义 |
| --- | --- | --- |
| `GroupHomework[] getList()` | `GroupHomework[]` | 获取群作业列表 |
* **GroupHomework**
**群作业详细信息**
| 方法 | 返回值类型 | 含义 |
| --- | --- | --- |
| Content[] getContents(String key)| `Content[]` | 作业的内容信息 |
| `String getCourseId()` | `String` | 科目ID |
| `String getCourseName()` | `String` | 科目名称 |
| `String getCoursePic()` | `String` | 该作业的科目图片链接 |
| `String getId()` | `String` | 该作业ID |
| `String getTitle()` | `String` | 该作业标题 |
| `String getType()` | `String` | 作业类型ID |
| `String getIcon()` | `String` | 该作业的图标链接 |
| Boolean isNeedFeedBack() | `Boolean` | 该作业是否需要反馈 |
| `String getAnnoNick()` | `String` | 发布人的昵称 |
| `String getAnnoQQ()` | `String` | 发布人的QQ号 |
| `String getStatus()` | `String` | 作业的目前状态 |
| `Long getTime()` | `Long` | 创建时间 |
* **Content**
**群作业信息**
| 方法 | 返回值类型 | 含义 |
| --- | --- | --- |
| `String getText()` | `String` | 获取内容 |
| `String getType()` | `String` | 获取类型 |
<br>
### **GroupInfo**
>[success] 群详细信息
| 方法 | 返回值类型 | 含义 |
| --- | --- | --- |
| `Integer getLevel()` | `Integer` | 群等级 |
| `Integer getOpenType()` | `Integer` | 加群方式 |
| `String getType()` | `String` | 群类型 |
| `Integer getTypeId()` | `Integer` | 群类型ID |
| `String[] getAdminList()` | `String[]` | 获取群管理列表 |
| `String getBoard()` | `String` | 最新的公告 |
| `Long getCreateTime()` | `Long` | 建群时间 |
| `String getSimpleIntro()` | `String` | 获取群介绍-简略 |
| `String getCompleteIntro()` | `String` | 获取群介绍-完整 |
| `Integer getMaxMember()` | `Integer` | 群成员上限 |
| `Integer getMemberNum()` | `Integer` | 群成员数量 |
| `String getName()` | `String` | 群名称 |
| `String getOwnerQQ()` | `String` | 群主QQ号 |
| `String getCode()` | `String` | 群号 |
| `Map<String, String> getLevelNames()` | `Map<String, String>` | 等级信息 |
| `Map<String, String> getAdminNickList()` | `Map<String, String>` | 获取群主和管理的QQ与昵称列表 |
| `String getPos()` | `String` | 获取群地址、坐标信息 |
| `Integer getSearchType()` | `Integer` | 群搜索类型 |
| `String[] getTags()` | `String[]` | 获取群标签 |
| `String getHeadUrl()` | `String` | 获取群头像 |
<br>
### **GroupLinkList**
>[success] 群链接地址列表
| 方法 | 返回值类型 | 含义 |
| --- | --- | --- |
| `GroupLink[] getList()` | `GroupLink[]` | 获取群链接地址列表 |
* **GroupLink**
**群链接**
| 方法 | 返回值类型 | 含义 |
| --- | --- | --- |
| `String getUrl()` | `String` | 链接地址 |
| `String getPicUrl()` | `String` | 链接的封面地址 |
| `Long getTime()` | `Long` | 发布时间 |
| `String getTitle()` | `String` | 标题 |
| `String getQQ()` | `String` | 该连接的发布者QQ |
<br>
### **GroupList**
>[success] 群列表
| 方法 | 返回值类型 | 含义 |
| --- | --- | --- |
| `Group[] getList()` | `Group[]` | 获取群列表 |
* **Group**
**群列表的群信息**
| 方法 | 返回值类型 | 含义 |
| --- | --- | --- |
| `String getName()` | `String` | 群名 |
| `String getCode()` | `String` | 群号 |
| `String getHeadUrl()` | `String` | 群头像地址 |
<br>
### **GroupMemberInfo**
>[success] 群成员信息
| 方法 | 返回值类型 | 含义 |
| --- | --- | --- |
| `String getCode()` | `String` | 获取群号 |
| `String getQQ()` | `String` | 成员QQ号 |
| `String getName()` | `String` | qq昵称 |
| `String getNickName()` | `String` | 群昵称 |
| `String getCard()` | `String` | 群名片 |
| `SexType getSex()` | `SexType` | 获取性别 |
| `String getCity()` | `String` | 所在城市 |
| `Long getJoinTime()` | `Long` | 加群时间 |
| `Long getLastTime()` | `Long` | 最后一次发言时间 |
| `PowerType getPowerType()` | `PowerType` | 权限类型 |
| `String getExTitle()` | `String` | 获取专属头衔 |
| `String getLevelName()` | `String` | 群成员等级名称 |
| `Boolean isBlack()` | `Boolean` | 是否为不良用户 |
| `Boolean isAllowChangeNick()` | `Boolean` | 是否允许修改群昵称 |
| `Long getExTitleTime()` | `Long` | 头衔的有效期 |
| `String getHeadImgUrl()` | `String` | 头像地址 |
| `Long getBanTime()` | `Long` | 禁言剩余时间 |
<br>
### **GroupMemberList**
>[success] 群成员列表
| 方法 | 返回值类型 | 含义 |
| --- | --- | --- |
| `GroupMember[] getList()` | `GroupMember[]` | 获取群成员列表 |
* **GroupMember**
**群成员信息**
| 方法 | 返回值类型 | 含义 |
| --- | --- | --- |
| `String getGroup()` | `String` | 群号 |
| `String getQQ()` | `String` | QQ号 |
| `String getName()` | `String` | QQ名 |
| `String getNickName()` | `String` | 获取群昵称 |
| `SexType getSex()` | `SexType` | 获取性别 |
| `String getCity()` | `String` | 所在城市 |
| `Long getJoinTime()` | `Long` | 加群时间 |
| `Long getLastTime()` | `Long` | 最后发言时间 |
| `PowerType getPower()` | `PowerType` | 权限类型 |
| `String getExTitle()` | `String` | 获取专属头衔 |
| `String getLevelName()` | `String` | 等级对应名称 |
| `Boolean isBlack()` | `Boolean` | 是否为不良用户 |
| `Boolean isAllowChangeNick()` | `Boolean` | 是否允许修改群名片 |
| `Long getExTitleTime()` | `Long` | 头衔到期时间 |
| `String getHeadUrl()` | `String` | 头像 |
<br>
### **GroupNoteList**
>[success] 群公告列表
| 方法 | 返回值类型 | 含义 |
| --- | --- | --- |
| `GroupNote[] getList()` | `GroupNote[]` | 获取群公告列表 |
* **GroupNote**
**群公告**
| 方法 | 返回值类型 | 含义 |
| --- | --- | --- |
| `String getId()` | `String` | ID |
| `String getMsg()` | `String` | 完整正文 |
| `String getFaceMsg()` | `String` | 预览文 |
| `String getTitle()` | `String` | 标题 |
| `Long getTime()` | `Long` | 发布时间 |
| `Integer getReadNum()` | `Integer` | 已读人数数量 |
| `Boolean isShowEditCard()` | `Boolean` | 是否提醒群员修改群名片 |
| `String getQQ()` | `String` | 发布者QQ |
| `String getTypeId()` | `String` | 公告类型ID |
<br>
### **GroupTopNote**
>[success] 置顶群公告
| 方法 | 返回值类型 | 含义 |
| --- | --- | --- |
| `String getId()` | `String` | ID |
| `String getMsg()` | `String` | 完整正文 |
| `String getFaceMsg()` | `String` | 预览文 |
| `String getTitle()` | `String` | 标题 |
| `Long getTime()` | `Long` | 发布时间 |
| `Integer getReadNum()` | `Integer` | 已读人数数量 |
| `Boolean isShowEditCard()` | `Boolean` | 是否提醒群员修改群名片 |
| `String getQQ()` | `String` | 发布者QQ |
| `String getTypeId()` | `String` | 公告类型ID |
<br>
### **ImageInfo**
>[success] 图片信息
| 方法 | 返回值类型 | 含义 |
| --- | --- | --- |
| `String getMD5()` | `String` | 取图片的MD5值 |
| `Double getWidth()` | `Double` | 图片宽 |
| `Double getHeight()` | `Double` | 图片长 |
| `Long getSize()` | `Long` | 获取图片大小 字节 |
| `String getUrl()` | `String` | 图片路径 |
| `Long getTime()` | `Long` | 图片上传到腾讯时候的时间 |
| `String getFileBase64()` | `String` | 图片Base64编码内容 |
<br>
### **LoginQQInfo**
>[success] 登录的QQ的信息
| 方法 | 返回值类型 | 含义 |
| --- | --- | --- |
| `String getName()` | `String` | 昵称 |
| `String getQQ()` | `String` | QQ号 |
| `String getHeadUrl()` | `String` | 头像地址 |
| `Integer getLevel()` | `Integer` | 等级 |
<br>
### **ShareList**
>[success] 群共享文件列表
| 方法 | 返回值类型 | 含义 |
| --- | --- | --- |
| `Share[] getList()` | `Share[]` | 获取群共享文件列表 |
* **Share**
**分享(文件)**
| 方法 | 返回值类型 | 含义 |
| --- | --- | --- |
| `String getBusid()` | `String` | BUSID |
| `Long getCreateTime()` | `Long` | 创建时间 |
| `Long getModiflyTime()` | `Long` | 上传完成时间 |
| `Integer getDLTimes()` | `Integer` | 下载次数 |
| `String getName()` | `String` | 文件名 |
| `String getFilePath()` | `String` | 文件路径 |
| `Long getSize()` | `Long` | 文件大小 |
| `String getLocalName()` | `String` | 本地文件名 |
| `String getNick()` | `String` | 上传者群昵称 |
| `String getQQ()` | `String` | 上传者QQ号 |
<br>
### **StrangerInfo**
>[success] 陌生人信息
| 方法 | 返回值类型 | 含义 |
| --- | --- | --- |
| `String getQQ()` | `String` | QQ号 |
| `SexType getSex()` | `SexType` | 性别 |
| `Integer getAge()` | `Integer` | 年龄 |
| `String headUrl()` | `String` | 头像地址 |
| `Integer getLevel()` | `Integer` | 等级 |
<br>
- 前言
- 简单介绍
- 我该如何阅读文档
- 视频教程
- 安装与使用
- 开源协议
- 免责&捐助
- 注意事项
- 版本命名规则简介
- 主要功能版本历史
- 功能指引
- 通用API与功能
- 国际化语言
- 异常
- 消息监听
- @Listen
- @OnListen模板
- @Filter
- 消息参数截取
- @Spare
- @Constr
- @Ignore
- @ListenBreak
- @ListenBreakPlugin
- @ListenBody
- 监听响应
- 成功判定与返回值
- 监听上下文
- 动态参数
- 监听消息API
- 异步监听 @Async
- 限流监听 @Limit
- 自定义Http送信器
- 枚举与类型
- 送信器
- SENDER
- SETTER
- GETTER
- 返回值
- 其他位置
- 日志与日志拦截
- 异常处理
- 依赖注入
- 自定义依赖获取
- 批量依赖载入
- 注意事项
- 常量
- 定时任务
- 自定义过滤
- 拦截器
- 拦截器总定义
- 上下文对象总定义
- 监听消息拦截
- 送信器拦截
- 监听函数拦截
- CAT码
- CQ码
- CQCode
- CQ码工具类
- CQ扩展工具类
- AppendList拼接链
- 高级内容
- 阻断机制
- 截断机制
- 自定义枚举类型
- 枚举工厂
- byName注解
- 自定义注解
- 配置
- 文件配置
- 注解配置
- 参数配置
- 多配置
- 多账号
- 自定义账号管理器
- 小心!
- 核心版本与组件如何升级核心
- 核心版本迭代指南
- 核心
- 更新日志
- jar包与依赖
- 监听消息类结构图
- 快速启动
- 模组与扩展
- 模组开发
- 现有模组
- 通用模组-延时任务
- 通用模组-CQ码工具
- 转义器
- CQ码操作工具类
- CQ码模板-CodeTemplate
- CQ码载体-KQCode
- CQ码构建器
- MQ码工具类
- 通用模组-redis-bot管理器
- 通用模组-Debugger
- Debugger-common模块
- Debugger-server模块
- Debugger-client模块
- 通用模组-钉钉机器人
- 组件-Mirai(JVM)
- 快速开始(1.13+)
- springboot-starter
- 注意事项
- 配置
- 额外的内容
- 快速回复
- 额外监听
- CQ码解析
- 组件-酷Q(QQ)-CQ HTTP API(基本失效)
- 快速开始(推荐)
- 快速开始(1.7.x以下,不推荐)
- 快速开始(Springboot启动器)
- 启动器、启动接口与配置类
- 配置
- 文件配置
- 注意事项
- 更新日志
- 额外的内容
- 自定义额外监听
- CQ送信器
- 元事件
- 监听消息类结构图
- 组件-酷Q(QQ)-JCQ(失效)
- 快速开始
- 更新日志
- 额外的内容
- JCQ日志
- 配置
- 注意事项
- 监听消息类结构图
- 组件-酷Q(QQ)-HTTP TO CQ(失效)
- 快速开始(核心1.7.x及以下)
- 启动器、启动接口与配置类
- 配置
- 文件配置
- 注意事项
- 更新日志
- 监听消息类结构图
- 组件-酷Q(QQ)-LEMOC (失效)
- 快速开始(核心1.7.x及以下)
- 配置
- 注意事项
- 更新日志
- 监听消息类结构图
- Springboot快速启动器
- 常见问题汇总
- BUG反馈
- 更新计划总览