mirai-console/net.mamoe.mirai.console.permission/AbstractPermitteeId

AbstractPermitteeId

@Serializable(with = AbstractPermitteeId.AsStringSerializer::class)
sealed class AbstractPermitteeId : PermitteeId

内建的 PermitteeId.

字符串表示

当使用 PermitteeId.asString 时, 不同的类型的返回值如下表所示. 这些格式也适用于 BuiltInCommands.PermissionCommand.

(不区分大小写. 不区分 Bot).

查看字符串表示列表

关系图

         Console                               AnyContact
                                                    ↑
                                                    |
                        +---------------------------+------------------------+---------------------+
                        |                                                    |                     |
                     AnyUser                                             AnyGroup            AnyOtherClient
                        ↑                                                    ↑                     ↑
                        |                                                    |                     |
         +--------------+---------------------+                              |                     |
         |              |                     |                              |                     |
    AnyFriend           |            AnyMemberFromAnyGroup                   |                     |
         ↑              |                     ↑                              |                     |
         |              |                     |                              |                     |
         |              |            +--------+--------------+               |                     |
         |              |            |                       |               |                     |
         |              |            |              AnyTempFromAnyGroup      |                     |
         |              |            |                       ↑               |                     |
         |              |        AnyMember                   |               |                     |
         |              |            ↑                       |               |                     |
         |          ExactUser        |                       |           ExactGroup         ExactOtherClient
         |            ↑   ↑          |                       |
         |            |   |          |                       |
         +------------+   +----------+                       |
         |                           |                       |
    ExactFriend                 ExactMember                  |
                                     ↑                       |
                                     |                       |
                                     +-----------------------+
                                                             |
                                                             |
                                                         ExactTemp
Content copied to clipboard

Inheritors

Types

Link copied to clipboard
Link copied to clipboard
object AnyFriend : AbstractPermitteeId

表示任何好友

Link copied to clipboard
object AnyGroup : AbstractPermitteeId

表示任何群对象. (不是指群成员, 而是指这个 '群')

Link copied to clipboard
data class AnyGroupTemp(val groupId: Long) : AbstractPermitteeId.AnyTemp

表示任何一个通过一个群 在临时会话发送消息的 群成员

Link copied to clipboard
data class AnyMember(val groupId: Long) : AbstractPermitteeId

表示来自一个群的任意一个成员

Link copied to clipboard
object AnyMemberFromAnyGroup : AbstractPermitteeId

表示来自任意群的任意一个成员

Link copied to clipboard
object AnyOtherClient : AbstractPermitteeId

表示任何其他客户端

Link copied to clipboard
Link copied to clipboard
object AnyTempFromAnyGroup : AbstractPermitteeId

表示任何一个 在临时会话发送消息的 群成员

Link copied to clipboard
object AnyUser : AbstractPermitteeId

表示任何 用户

Link copied to clipboard
Link copied to clipboard
object Companion
Link copied to clipboard
object Console : AbstractPermitteeId

表示控制台

Link copied to clipboard
data class ExactFriend(val id: Long) : AbstractPermitteeId

表示唯一的一个好友

Link copied to clipboard
data class ExactGroup(val groupId: Long) : AbstractPermitteeId

表示一个群

Link copied to clipboard
data class ExactGroupTemp(val groupId: Long, val memberId: Long) : AbstractPermitteeId.ExactTemp

表示唯一的一个 在临时会话发送消息的 群成员

Link copied to clipboard
data class ExactMember(val groupId: Long, val memberId: Long) : AbstractPermitteeId

表示唯一的一个群成员

Link copied to clipboard
data class ExactStranger(val id: Long) : AbstractPermitteeId

表示唯一的一个 陌生人

Link copied to clipboard
data class ExactUser(val id: Long) : AbstractPermitteeId

表示精确 用户

Functions

Link copied to clipboard
abstract fun asString(): String

转换为字符串表示. 用于权限服务识别和指令的解析.

Link copied to clipboard
@JvmStatic
@JvmName(name = "cancel0")
fun PermitteeId.cancel(permission: Permission, recursive: Boolean)
@JvmStatic
fun PermitteeId.cancel(permissionId: PermissionId, recursive: Boolean)
Link copied to clipboard
@JvmStatic
@JvmName(name = "getPermittedPermissions0")
fun PermitteeId.getPermittedPermissions(): Sequence<Permission>
Link copied to clipboard
@JvmStatic
fun PermitteeId.hasChild(child: PermitteeId): Boolean

当 this 或 this 的任意一个直接或间接父 PermitteeId.asString 与 this.asString 相同时返回 true

Link copied to clipboard
Link copied to clipboard
@JvmStatic
@JvmName(name = "permit0")
fun PermitteeId.permit(permission: Permission)
@JvmStatic
fun PermitteeId.permit(permissionId: PermissionId)
Link copied to clipboard
override fun toString(): String

Properties

Link copied to clipboard
@get:JvmStatic
val PermitteeId.allParents: Sequence<PermitteeId>

获取所有直接或间接父类的 PermitteeId, 返回包含 this + 这些父类 的 Sequence

Link copied to clipboard
@get:JvmStatic
val PermitteeId.allParentsWithSelf: Sequence<PermitteeId>

获取所有直接或间接父类的 PermitteeId.

Link copied to clipboard
override val directParents: Array<out PermitteeId>

直接父 PermitteeId. 在检查权限时会首先检查自己, 再递归检查父类.