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

Guild

interface Guild : Organization, GuildInfo(source)

一个频道服务器，或者说一个集会。

目前来看，大部分 guild 其本身是无法发送消息进行交流的。

Properties

Link copied to clipboard
abstract override val bot: GuildBot

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

Link copied to clipboard
open val category: Category?

此组织的"分组"。

Link copied to clipboard
abstract val channels: Items<Channel>

频道服务器的子集为 子频道 序列。

Link copied to clipboard
abstract override val children: Items<Channel>

频道服务器的子集为 子频道 序列。

Link copied to clipboard
abstract override val createTime: Timestamp

组织的创建时间。

Link copied to clipboard
abstract val currentChannel: Int

当前服务器内已存在频道数量。 如果无法获取，得到-1.

Link copied to clipboard
abstract override val currentMember: Int

当前组织内已存在成员数量。 如果无法获取，得到-1.

Link copied to clipboard
abstract override val description: String

组织的对外描述信息。

Link copied to clipboard
abstract override val icon: String

组织的图标/头像。

Link copied to clipboard
abstract override val id: ID

对于这个组织, 有一个唯一ID。

Link copied to clipboard
abstract val maximumChannel: Int

当前服务器内频道最大承载量。 如果无法获取，得到-1.

Link copied to clipboard
abstract override val maximumMember: Int

当前组织内成员最大承载量。 如果无法获取，得到-1.

Link copied to clipboard
abstract override val members: Items<GuildMember>

得到当前频道服务器中的成员列表序列。

Link copied to clipboard
abstract override val name: String

组织的名称。

Link copied to clipboard
abstract override val ownerId: ID

组织的拥有者的ID。

Link copied to clipboard
abstract val roles: Items<Role>

根据分组ID和限流器尝试获取当前组织下的所有角色。

Functions

Link copied to clipboard
abstract suspend fun channel(id: ID): Channel?

尝试根据指定ID获取匹配的子频道。

Link copied to clipboard
abstract suspend override fun child(id: ID): Channel?

尝试根据指定ID获取匹配的子频道。

Link copied to clipboard
inline operator fun OrganizationInfo.component1(): ID

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

Link copied to clipboard
inline operator fun OrganizationInfo.component2(): String

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

Link copied to clipboard
inline operator fun OrganizationInfo.component3(): String

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

Link copied to clipboard
abstract suspend override fun member(id: ID): GuildMember?

根据ID查询指定的成员对象。

Link copied to clipboard
open suspend fun mute(time: Long, timeUnit: TimeUnit): Boolean

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

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

对整个组织进行禁言。

Link copied to clipboard
@Api4J
open fun muteBlocking(): Boolean
@Api4J
open fun muteBlocking(duration: JavaDuration): Boolean

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

Link copied to clipboard
abstract suspend override fun owner(): GuildMember

组织的拥有者信息。

Link copied to clipboard
abstract suspend fun previous(): Organization?

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

Link copied to clipboard
infix fun IDContainer.sameIdWith(other: IDContainer): Boolean

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

Link copied to clipboard
abstract suspend override fun unmute(): Boolean

结束整个群的禁言。