mirai-console/net.mamoe.mirai.console.command/ConsoleCommandSender

ConsoleCommandSender

object ConsoleCommandSender : AbstractCommandSender, SystemCommandSender

控制台指令执行者. 代表由控制台执行指令

控制台拥有一切指令的执行权限.

不建议在 CompositeCommand 中使用 ConsoleCommandSender, 使用 SystemCommandSender 以允许其他插件执行

Functions

suspend fun CommandSender.add(account: Long, password: String, passwordKind: AutoLoginConfig.Account.PasswordKind = PLAIN)

asMessageScope

fun CommandSender.asMessageScope(): MessageScope

cancel

suspend fun CommandSender.cancel(target: PermitteeId, permission: Permission)

@JvmStatic

fun Permittee.cancel(vararg permissions: Permission, recursive: Boolean)

cancelAll

suspend fun CommandSender.cancelAll(target: PermitteeId, permission: Permission)

clear

suspend fun CommandSender.clear()

executeCommand

@JvmName(name = "execute0")

@ExperimentalCommandDescriptors

inline suspend fun CommandSender.executeCommand(message: String, checkPermission: Boolean = true): CommandExecuteResult

解析并执行一个指令

fold

inline fun <R> CommandSender.fold(ifIsSystem: SystemCommandSender.() -> R, ifIsUser: UserCommandSender.() -> R, otherwise: CommandSender.() -> R = { error("CommandSender ${this::class.qualifiedName} is not supported") }): R

折叠 CommandSender 的可能性.

getBotOrNull

fun CommandSender.getBotOrNull(): Bot?

尝试获取 Bot.

getGroupOrNull

fun CommandSender.getGroupOrNull(): Group?

尝试获取 Group.

getPermittedPermissions

@JvmStatic

fun Permittee.getPermittedPermissions(): Sequence<Permission>

handle

suspend fun CommandSender.handle()

@JvmOverloads

suspend fun CommandSender.handle(id: Long, password: String? = null, protocol: BotConfiguration.MiraiProtocol? = null)

suspend fun CommandSender.handle(id: Long)

suspend fun CommandSender.handle()

hasPermission

@JvmStatic

fun Permittee.hasPermission(permission: Permission): Boolean

@JvmStatic

fun Permittee.hasPermission(permissionId: PermissionId): Boolean

isConsole

fun CommandSender.isConsole(): Boolean

当 this 为 ConsoleCommandSender 时返回 true

isNotConsole

fun CommandSender.isNotConsole(): Boolean

当 this 不为 ConsoleCommandSender 时返回 true

isNotUser

fun CommandSender.isNotUser(): Boolean

当 this 不为 UserCommandSender, 即为 SystemCommandSender 时返回 true

isSystem

fun CommandSender.isSystem(): Boolean

当 this 为 SystemCommandSender 时返回 true

isUser

fun CommandSender.isUser(): Boolean

当 this 为 UserCommandSender 时返回 true

list

suspend fun CommandSender.list()

listPermissions

suspend fun CommandSender.listPermissions()

permit

suspend fun CommandSender.permit(target: PermitteeId, permission: Permission)

@JvmStatic

fun Permittee.permit(vararg permissions: Permission)

permittedPermissions

suspend fun CommandSender.permittedPermissions(target: PermitteeId, all: Boolean = true)

remove

suspend fun CommandSender.remove(account: Long)

removeConfig

@ConsoleExperimentalApi

suspend fun CommandSender.removeConfig(account: Long, configKey: AutoLoginConfig.Account.ConfigurationKey)

scopeWith

inline fun CommandSender.~~scopeWith~~(): MessageScope

inline fun <R> CommandSender.~~scopeWith~~(action: MessageScope.() -> R): R

fun CommandSender?.scopeWith(vararg others: CommandSender?): MessageScope

fun CommandSender?.scopeWith(vararg others: MessageScope?): MessageScope

fun CommandSender?.scopeWith(vararg others: Contact?): MessageScope

fun CommandSender?.scopeWith(other: CommandSender?): MessageScope

fun CommandSender?.scopeWith(other: MessageScope?): MessageScope

fun CommandSender?.scopeWith(other: Contact?): MessageScope

inline fun <R> CommandSender?.scopeWith(vararg others: CommandSender?, action: MessageScope.() -> R): R

inline fun <R> CommandSender?.scopeWith(vararg others: MessageScope?, action: MessageScope.() -> R): R

inline fun <R> CommandSender?.scopeWith(vararg others: Contact?, action: MessageScope.() -> R): R

sendAnsiMessage

inline suspend fun CommandSender.sendAnsiMessage(message: String): MessageReceipt<Contact>?

inline suspend fun CommandSender.sendAnsiMessage(capacity: Int = 16, builder: AnsiMessageBuilder.() -> Unit): MessageReceipt<Contact>?

向 CommandSender 发送一条带有 ANSI 控制符的信息

sendMessage

open suspend override fun sendMessage(message: String): Nothing?

open suspend override fun sendMessage(message: Message): Nothing?

立刻发送一条消息.

setConfig

@ConsoleExperimentalApi

suspend fun CommandSender.setConfig(account: Long, configKey: AutoLoginConfig.Account.ConfigurationKey, value: String)

toString

open override fun toString(): String

Properties

bot

open override val bot: Nothing?

与这个 CommandSender 相关的 Bot. 当通过控制台执行时为 null.

coroutineContext

open override val coroutineContext: CoroutineContext

isAnsiSupported

open override val isAnsiSupported: Boolean

当前 SystemCommandSender 是否支持 Ansi 信息

NAME

const val NAME: String

name

open override val name: String

User.nameCardOrNick 或 ConsoleCommandSender.NAME

permitteeId

open override val permitteeId: AbstractPermitteeId.Console

subject

open override val subject: Nothing?

与这个 CommandSender 相关的 Contact.

user

open override val user: Nothing?

指令原始发送人.