ContactsContainer

提供获取 Contact 的容器。

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

联系人 通常代表为与当前容器存在"会话"或可以建立会话的目标, 它们之间必须存在一种硬性关系(例如它们之间是 好友 关系) 或者存在一个被创建过的"会话"(例如某联系人主动与bot进行过交流或者 与当前容器(Bot)创建过与某个目标的会话)。

因上述约束,ContactsContainer.contacts 通常不具备检索 组织成员 Member 这类间接联系人的能力, 尽管 Member 也属于 Contact 类型 ———— 除非它们与当前容器存在直接会话。

当一个bot中,所有可能的联系人都是与bot存在硬性关系(例如它们之间是 好友 关系)的时候, ContactsContainer 的表现将会与 FriendsContainer 类似。

Functions

Link copied to clipboard
abstract suspend fun contact(id: ID): Contact?

通过唯一标识获取对应的 Contact 实例。当且仅当因标识对应联系人不存在而导致无法获取时得到null。

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

得到当前容器中所有联系人的总数量。

Properties

Link copied to clipboard
abstract val contacts: Items<Contact>

得到当前容器中能够获取到的联系人序列。

Link copied to clipboard

是否支持contacts相关的获取操作。当 contactscontact 都不被支持时得到 false。 默认情况下视其为 true,由实现者重写此属性来决定其可用性。

Inheritors

Link copied to clipboard