simbot-component-kook-core/love.forte.simbot.component.kook/KookGuild

KookGuild

interface KookGuild : Guild, CoroutineScope, KookRoleOperator(source)

一个 KOOK 中的频道服务器。

Author

ForteScarlet

Properties

@ExperimentalSimbotAPI

abstract val categories: Collectable<KookCategoryChannel>

得到当前频道下所有的分组型频道。

abstract override val channels: Collectable<KookChannel>

获取当前频道服务器下的子频道序列。

abstract override val chatChannels: Collectable<KookChatChannel>

获取此频道服务器内的所有聊天频道集合。

coroutineContext

abstract override val coroutineContext: CoroutineContext

源于 bot 的上下文，但是没有 Job。

open val icon: String

服务器icon的地址

open override val id: ID

频道服务器ID

abstract override val members: Collectable<KookMember>

此频道下的成员序列。

open override val name: String

频道服务器名称

abstract override val ownerId: ID?

当前频道的创建人ID

@ExperimentalSimbotAPI

open override val roles: Collectable<KookGuildRole>

获取当前频道服务器中配置的所有角色信息。

abstract val source: Guild

得到此 Guild 内对应的 api 模块下的原始 guild 信息。

open val topic: String

服务器主题

Functions

abstract suspend override fun botAsMember(): KookMember

abstract suspend override fun channel(id: ID): KookChannel?

尝试根据指定ID获取匹配的 KookChatChannel。未找到时得到null。

abstract suspend override fun chatChannel(id: ID): KookChatChannel?

尝试根据指定ID获取匹配的 KookChatChannel。未找到时得到null。

@ExperimentalSimbotAPI

abstract fun getCategory(id: ID): KookCategoryChannel?

尝试根据ID获取匹配的分类对象。

@ExperimentalSimbotAPI

abstract fun getRoles(startPage: Int?, pageSize: Int?): Collectable<KookGuildRole>

获取当前频道服务器中配置的所有角色信息。

abstract suspend override fun member(id: ID): KookMember?

根据ID寻找一个此频道下的成员。

abstract suspend fun owner(): KookMember

获取当前频道的创建人。

@ExperimentalSimbotAPI

abstract override fun roleCreator(): KookGuildRoleCreator

构建一个针对当前频道服务器的角色创建器，用于构建一个新的角色 Role。

Inherited functions

@ExperimentalSimbotAPI

inline suspend fun KookRoleOperator.createRole(block: KookGuildRoleCreator.() -> Unit): KookGuildRole

使用 DSL 风格API创建一个 KookGuildRole.