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

PermissionService

@PermissionImplementation

interface PermissionService<P : Permission>

权限服务. 用于承载 Console 的权限系统.

可扩展

权限服务可由插件扩展并覆盖默认实现.

See also

net.mamoe.mirai.console.extensions.PermissionServiceProvider

相应扩展

Types

object Companion

Functions

allocatePermissionIdForPlugin

@ConsoleExperimentalApi

open fun allocatePermissionIdForPlugin(plugin: Plugin, permissionName: String): PermissionId

为 Plugin 分配一个 PermissionId

abstract fun cancel( permitteeId: PermitteeId, permission: P, recursive: Boolean)

撤销 permitteeId 的 permission 授权

abstract operator fun get(id: PermissionId): P?

获取一个已经注册了的 P

getPermittedPermissions

abstract fun getPermittedPermissions(permitteeId: PermitteeId): Sequence<P>

获取 PermitteeId 和其父标识的所有被授予的所有直接和间接的权限列表

getRegisteredPermissions

abstract fun getRegisteredPermissions(): Sequence<P>

获取所有已注册的指令列表. 应保证线程安全.

abstract fun permit(permitteeId: PermitteeId, permission: P)

授予 permitteeId 以 permission 权限

abstract fun register( id: PermissionId, description: String, parent: Permission = RootPermission): P

申请并注册一个权限 Permission.

open fun testPermission(permitteeId: PermitteeId, permission: P): Boolean

判断 permission 对 permission 的权限.

Properties

abstract val permissionType: KClass<P>

P 的类型

abstract val rootPermission: P

RootPermission 的实现

Extensions

fun <P : Permission> PermissionService<P>.getOrFail(id: PermissionId): P

获取一个权限, 失败时抛出 NoSuchElementException