simbot-api/love.forte.simbot.action/MuteSupport

MuteSupport

interface MuteSupport(source)

一个禁言行为。

对于禁言，在支持的情况下存在如下场景：

针对一个成员，此操作在权限等外在因素允许的情况下，会对其进行禁言。
针对一个组织，此操作在权限等外在因素允许的情况下，会对其整体进行禁言。

目前来看，禁言可能存在两种形式：

文字方面的禁言，这一般体现在对于一个文字交流群或者频道.
语音方面的禁言，这一般体现在对于一个通过语音交流的群或频道。

除了上述两种目前已知的常见形式之外，可能会在未来产生新的情况，例如存在允许同时进行语音、文字交流的聊天室、视频聊天的聊天室等。

目前，MuteSupport 默认实现于 love.forte.simbot.definition.Member 和 love.forte.simbot.definition.Organization，但是api无法保证其实现者能够完美支持此行为，因此在行为不被支持的时候，可能会抛出 UnsupportedActionException 异常或永远返回一个无效结果。

Author

ForteScarlet

Inheritors

Types

object Companion

Functions

abstract suspend fun mute(duration: Duration = DEFAULT_DURATION): Boolean

open suspend fun mute(time: Long, timeUnit: TimeUnit): Boolean

对当前目标进行禁言操作。

open fun muteBlocking(): Boolean

open fun muteBlocking(duration: JavaDuration): Boolean

对当前目标进行禁言操作。

abstract suspend fun unmute(): Boolean

对当前目标进行 解除禁言 操作。