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

CommandSenderOnMessage

interface CommandSenderOnMessage<T : MessageEvent> : CommandSender

代表一个真实 用户 主动私聊机器人或在群内发送消息而执行指令

See also

代表一个真实的 群员 主动在群内发送消息执行指令.

代表一个真实的 好友 主动在私聊消息执行指令

代表一个 群员 主动在临时会话发送消息执行指令

Inheritors

Functions

Link copied to clipboard
@ConsoleExperimentalApi
suspend fun CommandSender.add(account: Long, password: String, passwordKind: AutoLoginConfig.Account.PasswordKind = PLAIN)
Link copied to clipboard
Link copied to clipboard
suspend fun CommandSender.cancel(target: PermitteeId, permission: Permission)
@JvmStatic
fun Permittee.cancel(vararg permissions: Permission, recursive: Boolean)
Link copied to clipboard
suspend fun CommandSender.cancelAll(target: PermitteeId, permission: Permission)
Link copied to clipboard
suspend fun CommandSender.clear()
Link copied to clipboard
@JvmName(name = "execute0")
@ExperimentalCommandDescriptors
inline suspend fun CommandSender.executeCommand(message: String, checkPermission: Boolean = true): CommandExecuteResult

解析并执行一个指令

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

折叠 CommandSender 的可能性.

Link copied to clipboard
fun CommandSender.getBotOrNull(): Bot?

尝试获取 Bot.

Link copied to clipboard
fun CommandSender.getGroupOrNull(): Group?

尝试获取 Group.

Link copied to clipboard
Link copied to clipboard
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()
suspend fun CommandSender.handle()
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
fun CommandSender.isNotConsole(): Boolean

当 this 不为 ConsoleCommandSender 时返回 true

Link copied to clipboard
fun CommandSender.isNotUser(): Boolean

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

Link copied to clipboard
fun CommandSender.isSystem(): Boolean

当 this 为 SystemCommandSender 时返回 true

Link copied to clipboard
fun CommandSender.isUser(): Boolean

当 this 为 UserCommandSender 时返回 true

Link copied to clipboard
suspend fun CommandSender.list()
Link copied to clipboard
Link copied to clipboard
suspend fun CommandSender.permit(target: PermitteeId, permission: Permission)
@JvmStatic
fun Permittee.permit(vararg permissions: Permission)
Link copied to clipboard
suspend fun CommandSender.permittedPermissions(target: PermitteeId, all: Boolean = true)
Link copied to clipboard
suspend fun CommandSender.remove(account: Long)
Link copied to clipboard
Link copied to clipboard
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
Link copied to clipboard
inline suspend fun CommandSender.sendAnsiMessage(message: String): MessageReceipt<Contact>?
inline suspend fun CommandSender.sendAnsiMessage(capacity: Int = 16, builder: AnsiMessageBuilder.() -> Unit): MessageReceipt<Contact>?

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

Link copied to clipboard
abstract suspend fun sendMessage(message: String): MessageReceipt<Contact>?
abstract suspend fun sendMessage(message: Message): MessageReceipt<Contact>?

立刻发送一条消息.

Link copied to clipboard

Properties

Link copied to clipboard
abstract val bot: Bot?

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

Link copied to clipboard
Link copied to clipboard
abstract val fromEvent: T

消息源 MessageEvent

Link copied to clipboard
Link copied to clipboard
abstract val permitteeId: PermitteeId
Link copied to clipboard
abstract val subject: Contact?

与这个 CommandSender 相关的 Contact.

Link copied to clipboard
abstract val user: User?

指令原始发送人.