OneBotMember

OneBot中的 memberMember 实现。

群成员通常的来源:

DeleteSupport

OneBotMember 实现 DeleteSupportdelete 代表试着踢出这个群成员。

Author

ForteScarlet

Properties

Link copied to clipboard
open override val avatar: String

成员QQ头像

Link copied to clipboard
abstract override val coroutineContext: CoroutineContext

协程上下文。源自 OneBotBot, 但是不含 Job

Link copied to clipboard
abstract override val id: ID

成员群号

Link copied to clipboard
abstract override val name: String

群成员的QQ名。

Link copied to clipboard
abstract override val nick: String?

群成员在群内的昵称, 即群成员在群里的群备注,也就是 card。 如果备注为空字符串,则会被视为 null,也就是没有备注。

Link copied to clipboard
abstract val role: OneBotMemberRole?

此成员所属角色。 如果无法获取(例如是在群临时会话的私聊中)则得到 null

Functions

Link copied to clipboard
abstract suspend fun ban(duration: Duration)

禁言此成员。 禁言时长范围应当在 1m ~ 30d 之间, 不过 duration 最终会被转为秒值。 如果值为 Duration.ZERO 或最终秒值为 0 则等同于 unban, 如果转化后的秒值为负数,则会抛出 IllegalArgumentException

abstract suspend fun ban(duration: Long, unit: TimeUnit)

禁言此成员。 禁言时长范围应当在 1m ~ 30d 之间, 不过 duration 最终会根据 unit 被转为秒值。 如果最终秒值为 0 则等同于 unban, 如果 duration 为负数,则会抛出 IllegalArgumentException

Link copied to clipboard
abstract suspend override fun delete(vararg options: DeleteOption)

尝试踢出此群成员,类似于 kick 行为。

Link copied to clipboard

获取当前成员在API GetGroupMemberInfoApi 中的响应结果。 根据 OneBotMember 具体实现的不同,可能会发起API请求 (例如 OneBotMember 来自事件), 也可能会直接获取缓存信息(例如 OneBotMember 来自 OneBotGroup.member)。

Link copied to clipboard
abstract suspend override fun send(text: String): OneBotMessageReceipt
abstract suspend override fun send(message: Message): OneBotMessageReceipt
abstract suspend override fun send(messageContent: MessageContent): OneBotMessageReceipt

向此成员发送消息。

Link copied to clipboard
abstract suspend fun setAdmin(enable: Boolean)

设置当前群成员为管理员/撤销其管理员。

Link copied to clipboard
abstract suspend fun setNick(newNick: String?)

设置成员在此群内的群备注。

Link copied to clipboard
abstract suspend fun setSpecialTitle(specialTitle: String? = null)
abstract suspend fun setSpecialTitle(specialTitle: String, duration: Duration)
abstract suspend fun setSpecialTitle(specialTitle: String, duration: Long, timeUnit: TimeUnit)

使用 SetGroupSpecialTitleApi 为群成员设置专属头衔。 通常要求bot拥有群主权限。

Link copied to clipboard
open suspend fun unban()

取消此成员禁言。相当于 ban(Duration.ZERO)

Inherited functions

Link copied to clipboard
abstract suspend fun toStranger(): OneBotStranger

查询并得到对应的 OneBotStranger 信息。