mirai-core-api/net.mamoe.mirai.contact.friendgroup/FriendGroup

FriendGroup

@NotStableForInheritance
interface FriendGroup

一个好友分组. 可能同时存在多个相同名称的分组, 但是每个分组的 id 都是唯一的.

要获取一个分组, 可使用 get 根据 ID 获取, 或者使用 asCollection 获取全部分组列表. 也可以通过 Friend.friendGroup 获取一个好友所在的分组.

在每次登录会话中, FriendGroup 的实例是依据 id 唯一的. 存在于同一个分组中的多个好友的 Friend.friendGroup 会返回相同的 FriendGroup 实例. 但当 bot 重新登录后, 实例可能变化.

Since

2.13

See also

Functions

Link copied to clipboard
abstract suspend fun delete(): Boolean

删除本分组.

Link copied to clipboard
abstract suspend fun moveIn(friend: Friend): Boolean

把一名好友移动至本分组内.

Link copied to clipboard
abstract suspend fun renameTo(newName: String): Boolean

更改好友分组名称.

Properties

Link copied to clipboard
abstract val count: Int

好友分组内好友数量

Link copied to clipboard
abstract val friends: Collection<Friend>

属于本分组的好友集合

Link copied to clipboard
abstract val id: Int

好友分组 ID

Link copied to clipboard
abstract val name: String

好友分组名