FriendsContainer

提供获取 Friend 的容器。

通常应用于 Bot 中为其提供获取 Friend 相关的属性api。

Bot 或许会存在一些 "好友" 对象,但是 Bot 不会默认实现 FriendsContainer, 取而代之的是 ContactsContainer。当组件存在支持 Friend 相关操作的时候可以进行额外实现。

"好友"并 不一定 代表那些需要 "添加申请"、"同意" 后出现在好友列表中的好友, 也并非所有的组件都支持“好友”的概念。

对于一个以"频道"概念为主的组件就是最常见的例子(例如Kook) —— 它们通常没有真正的"好友"概念, 至少对于bot来讲没有。取而代之的则通常是"频道成员"或者一个"会话"。

实际上,对于一个bot来讲"好友"的概念确实可有可无,它更需要"联系人"。

在一个容器同时支持 FriendsContainerContactsContainer 的情况下,FriendsContainer 中能够得到的目标常常为 ContactsContainer子集但是这并不绝对。

See also

Functions

Link copied to clipboard
abstract suspend fun friend(id: ID): Friend?

通过唯一标识获取这个容器对应的某个好友,获取不到则为null。

Link copied to clipboard
open suspend fun friendCount(): Int

得到当前容器中所有好友的总数量。

Properties

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

得到此容器下的好友序列。