simbot-component-kook-core/love.forte.simbot.component.kook.role/KookGuildRole

KookGuildRole

@ExperimentalSimbotAPI

interface KookGuildRole : KookRole(source)

代表一个频道服务器所拥有的角色。

查询

KookGuildRole 通过 KookGuild.roles 进行列表查询。

删除

当权限足够时，可以通过 delete 对某个角色进行删除。

更新

当权限足够时，可通过 updater 获取更新器进行更新。当通过 updater 更新信息成功后，当前 KookGuildRole 内部的信息会随之改变。

对Java来讲可以使用惯用的链式API：

role.updater()
        .name("文丑")
        .isHoist(true)
        .permissions(123)
        // other...
        .updateBlocking(); // or updateAsync

Kotlin则可以选择通过 update { ... } 使用DSL风格的API

val updated = role.update { // suspend
    name = "老生"
    isHoist = true
    color = 123
    // other...
}

赋予

一个 KookGuildRole 可以通过 grantTo 赋予给一个指定的成员，并得到一个赋予后的 KookMemberRole 实例。

创建

通过 KookGuild.roleCreator 可以得到一个角色的构造器，并在通过API创建角色成功后得到一个 KookGuildRole 实例。

Java可以使用惯用的链式API:

KookGuildRole newRole = guild.roleCreator()
        .name("青衣")
        // other...
        .createBlocking(); // or createAsync

Kotlin可以通过 createRole { ... } 使用 DSL 风格的API:

val newRole = role.createRole {
    name = "花旦"
    // other...
}

统一性说明参考 KookRole

Author

ForteScarlet

Properties

guild

abstract val guild: KookGuild

当前角色所属的频道服务器。

Inherited properties

open override val id: ID

角色ID

isAdmin

open override val isAdmin: Boolean

是否拥有管理权限。

name

open override val name: String

角色名

permissions

open val permissions: Permissions

角色的权限值。

permissionsValue

open val permissionsValue: Int

角色的权限值。

source

abstract val source: Role

得到当前Role对应的原始API返回类型 Role.

Functions

delete

abstract suspend override fun delete(vararg options: DeleteOption)

删除当前频道中对应的角色。

grantTo

abstract suspend fun grantTo(memberId: ID): KookMemberRole

将当前角色赋予给指定 memberId 的用户。

abstract suspend fun grantTo(member: KookMember): KookMemberRole

open suspend fun grantTo(member: Member): KookMemberRole

将当前角色赋予给指定用户 member 。

updater

abstract fun updater(): KookGuildRoleUpdater

构建一个用于更新当前角色信息的 KookGuildRoleUpdater.

KookGuildRole

查询

删除

更新

赋予

创建

Author

See also

Properties

Inherited properties

Functions