GroupActive

interface GroupActive : Streamable<ActiveRecord>

表示一个群活跃度管理.

获取 GroupActive 实例

只可以通过 Group.active 获取一个群的活跃度管理, 即 GroupActive 实例.

头衔设置

  • 通过 isHonorVisible 可以获取和设置一个群的荣誉是否显示,

  • 通过 isTitleVisible 可以获取和设置一个群的头衔是否显示,

  • 通过 isTemperatureVisible 可以获取和设置一个群的活跃度是否显示,

  • 通过 rankTitles 可以获取和设置一个群的等级头衔列表 (PC 端显示),

  • 通过 temperatureTitles 可以获取和设置一个群的活跃度头衔列表 (手机端显示)

刷新群成员活跃数据

通过 refresh 可以刷新 Member.active 中的属性 (不包括 honors 和 temperature)

活跃度记录

通过 asFlow 可以获取群活跃度记录惰性流.

若要获取全部活跃度记录, 可使用 toList.

活跃度图表

通过 queryChart 可以获取活跃度图表, 包括

通过 queryHonorHistory 可以获取群荣耀历史数据, 包括

Since

2.13

Functions

Link copied to clipboard
expect abstract fun asFlow(): Flow<ActiveRecord>

创建一个能获取 TFlow.

Link copied to clipboard
abstract suspend fun queryActiveRank(): List<ActiveRankRecord>

获取活跃度排行榜,通常是前五十名

Link copied to clipboard
abstract suspend fun queryChart(): ActiveChart

获取活跃度图表数据

Link copied to clipboard
@JvmName(name = "queryHonorHistory")
abstract suspend fun queryHonorHistory(type: GroupHonorType): ActiveHonorList

获取群荣耀历史数据, 刷新 Member.active 中的 MemberActive.honors

Link copied to clipboard
abstract suspend fun refresh()

刷新 Member.active 中的属性 (不包括 honorstemperature)

Link copied to clipboard
abstract suspend fun setHonorVisible(newValue: Boolean)

设置是否在群聊中显示荣誉

Link copied to clipboard
abstract suspend fun setRankTitles(newValue: Map<Int, String>)

设置等级头衔列表,键是等级,值是头衔。操作成功时会同时刷新等级头衔信息。

Link copied to clipboard
abstract suspend fun setTemperatureTitles(newValue: Map<Int, String>)

设置活跃度头衔列表,键是等级,值是头衔。操作成功时会同时刷新活跃度头衔信息。

Link copied to clipboard
abstract suspend fun setTemperatureVisible(newValue: Boolean)

设置是否在群聊中显示活跃度。操作成功时会同时刷新等级头衔信息。

Link copied to clipboard
abstract suspend fun setTitleVisible(newValue: Boolean)

设置是否在群聊中显示头衔。操作成功时会同时刷新等级头衔信息。

Link copied to clipboard
expect open suspend fun toList(): List<ActiveRecord>

获取所有 T 列表, 将全部 T 都加载后再返回.

Properties

Link copied to clipboard
abstract val isHonorVisible: Boolean

是否在群聊中显示荣誉

Link copied to clipboard
abstract val isTemperatureVisible: Boolean

是否在群聊中显示活跃度

Link copied to clipboard
abstract val isTitleVisible: Boolean

是否在群聊中显示头衔

Link copied to clipboard
abstract val rankTitles: Map<Int, String>

等级头衔列表,键是等级,值是头衔

Link copied to clipboard
abstract val temperatureTitles: Map<Int, String>

活跃度头衔列表,键是等级,值是头衔。操作成功时会同时刷新活跃度头衔信息。