simbot-api/love.forte.simbot.definition/ChatRoom

ChatRoom

interface ChatRoom : Organization, SendSupport(source)

一个 聊天室。聊天室是组织的子类型，代表其是一个存在多人且允许相互交流“发送消息”的组织。

聊天室实现 SendSupport ，允许发送消息。

Author

ForteScarlet

Inheritors

Channel

Group

Properties

bot

abstract override val bot: OrganizationBot

这个组织一定是属于某一个Bot之下的。

Functions

child

open suspend override fun child(id: ID): Organization?

根据ID寻找当前聊天室下匹配的子聊天室。

component1

inline operator fun OrganizationInfo.component1(): ID

OrganizationInfo 解构扩展。第1个参数，相当于 OrganizationInfo.id

component2

inline operator fun OrganizationInfo.component2(): String

OrganizationInfo 解构扩展。第2个参数，相当于 OrganizationInfo.name

component3

inline operator fun OrganizationInfo.component3(): String

OrganizationInfo 解构扩展。第3个参数，相当于 OrganizationInfo.icon

member

abstract suspend fun member(id: ID): Member?

尝试通过ID获取一个成员，无法获取则得到null。

mute

open suspend fun mute(time: Long, timeUnit: TimeUnit): Boolean

对当前目标进行禁言操作。

abstract suspend override fun mute(duration: Duration): Boolean

对整个组织进行禁言。

muteBlocking

@Api4J

open fun muteBlocking(): Boolean

@Api4J

open fun muteBlocking(duration: JavaDuration): Boolean

对当前目标进行禁言操作。

owner

abstract suspend fun owner(): Member

组织的拥有者信息。

abstract suspend fun previous(): Organization?

上一级，或者说这个组织的上层。组织有可能是层级的，因此一个组织结构可能会有上一层的组织。当然，也有可能不存在。不存在的时候，那么这个组织就是顶层。

sameIdWith

infix fun IDContainer.sameIdWith(other: IDContainer): Boolean

比较两个 IDContainer 的 IDContainer.id 是否一致。

send

open suspend fun send(text: String): MessageReceipt

发送一段纯文本消息。

abstract suspend fun send(message: Message): MessageReceipt

open suspend fun send(message: MessageContent): MessageReceipt

发送消息，并得到一个回执单。

unmute

abstract suspend override fun unmute(): Boolean

结束整个群的禁言。