mute

API 请求过程中产生的异常

API 请求过程中产生的异常

abstract suspend fun mute(type: Int, duration: Duration): Boolean(source)

open suspend fun mute(type: MuteType, duration: Duration): Boolean(source)

设置频道成员的静音状态。

type 的值可参考静音API CreateGuildMuteApi 的参数 type 或 MuteType。

有效期

duration 可以在程序内存级别追加一个“有效期”，当 duration 实际持续时间的毫秒大于0时有效。

duration 是在当前程序内通过内部延迟完成的。当周期时间到达时，会主动调用取消禁言的API来实现“有效期”功能。

因此需要注意：duration 提供的"有效期"能力 不可靠 ，它有可能会因为如下原因而导致无法正确取消指定用户的静音状态：

程序中断
Bot终止
成员退出服务器（如果在有效期内再次返回频道，不会恢复静音状态，也不会有取消静音的任务被执行）
取消禁言时BOT已经不再拥有相关权限
其他预料之外的情况

Throws

API 请求过程中产生的异常

API 请求过程中产生的异常

abstract suspend fun mute(type: Int, time: Long, timeUnit: TimeUnit): Boolean(source)

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

设置频道成员的静音状态。

type 的值可参考静音API CreateGuildMuteApi 的参数 type 或 MuteType。

有效期

time 和 timeUnit 可以在程序内存级别追加一个“有效期”，当 time 和 timeUnit 实际持续时间的毫秒大于0时有效。

time 和 timeUnit 是在当前程序内通过内部延迟完成的。当周期时间到达时，会主动调用取消禁言的API来实现“有效期”功能。

因此需要注意：time 和 timeUnit 提供的"有效期"能力 不可靠 ，它有可能会因为如下原因而导致无法正确取消指定用户的静音状态：

程序中断
Bot终止
成员退出服务器（如果在有效期内再次返回频道，不会恢复静音状态，也不会有取消静音的任务被执行）
取消禁言时BOT已经不再拥有相关权限
其他预料之外的情况

Throws

API 请求过程中产生的异常

API 请求过程中产生的异常

open suspend fun mute(duration: Duration): Boolean(source)

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

设置频道成员的麦克风静音状态。

更多详细描述参考存在 type 参数的 mute API。

Throws

API 请求过程中产生的异常