Merge pull request #29 from simple-robot/set-group-card

OneBotMember和OneBotGroup增加设置群成员群备注(card)的API支持

Author: ForteScarlet

simbot-component-onebot-v11/simbot-component-onebot-v11-core/src/commonMain/kotlin/love/forte/simbot/component/onebot/v11/core/actor/OneBotGroup.kt

@@ -150,8 +150,7 @@ public interface OneBotGroup : ChatGroup, DeleteSupport {
      * 当 [setName] 修改成功后会影响 [name] 的值，
      * 但是仅会影响 **当前对象** 内的属性值。
      *
-     * [name] 在内部的实现应当是 `Volatile` 的，
-     * 但是 [setName] 不保证并发安全也不会加锁，
+     * [setName] 不保证并发安全也不会加锁，
      * 如果并发请求 [setName]，无法保证 [name] 的最终结果。
      *
      * @param newName 要设置的新群名
@@ -160,6 +159,17 @@ public interface OneBotGroup : ChatGroup, DeleteSupport {
      */
     @ST
     public suspend fun setName(newName: String)
+
+    /**
+     * 设置 bot 在此群内的群备注。
+     *
+     * @see OneBotMember.nick
+     *
+     * @param newNick 要设置的新备注, `null` 或空字符串代表删除备注
+     * @throws Throwable 任何在请求API过程中可能产生的异常
+     */
+    @ST
+    public suspend fun setBotGroupNick(newNick: String?)
 }
 
 /**

simbot-component-onebot-v11/simbot-component-onebot-v11-core/src/commonMain/kotlin/love/forte/simbot/component/onebot/v11/core/actor/OneBotMember.kt

@@ -79,6 +79,37 @@ public interface OneBotMember : Member, DeleteSupport {
     override val avatar: String
         get() = qqAvatar640(id.literal)
 
+    /**
+     * 群成员的QQ名。
+     */
+    override val name: String
+
+    /**
+     * 群成员在群内的昵称，
+     * 即群成员在群里的群备注，也就是 `card`。
+     * 如果备注为空字符串，则会被视为 `null`，也就是没有备注。
+     *
+     * 不支持获取的情况下也会得到 `null`，例如在临时会话中。
+     */
+    override val nick: String?
+
+    /**
+     * 设置成员在此群内的群备注。
+     *
+     * 当 [setNick] 修改成功后会影响 [nick] 的值，
+     * 但是仅会影响 **当前对象** 内的属性值。
+     *
+     * [setNick] 不保证并发安全也不会加锁，
+     * 如果并发请求 [setNick]，无法保证 [nick] 的最终结果。
+     *
+     * @see nick
+     *
+     * @param newNick 要设置的新备注, `null` 或空字符串代表删除备注
+     * @throws Throwable 任何在请求API过程中可能产生的异常
+     */
+    @ST
+    public suspend fun setNick(newNick: String?)
+
     /**
      * 向此成员发送消息。
      *

simbot-component-onebot-v11/simbot-component-onebot-v11-core/src/commonMain/kotlin/love/forte/simbot/component/onebot/v11/core/actor/internal/OneBotGroupImpl.kt

@@ -159,6 +159,14 @@ internal abstract class OneBotGroupImpl(
         this.name = newName
     }
 
+    override suspend fun setBotGroupNick(newNick: String?) {
+        SetGroupCardApi.create(
+            groupId = id,
+            userId = bot.userId,
+            card = newNick
+        ).requestDataBy(bot)
+    }
+
     override fun toString(): String = "OneBotGroup(id=$id, bot=${bot.id})"
 }
 

simbot-component-onebot-v11/simbot-component-onebot-v11-core/src/commonMain/kotlin/love/forte/simbot/component/onebot/v11/core/actor/internal/OneBotMemberImpl.kt

@@ -24,10 +24,7 @@ import love.forte.simbot.common.time.TimeUnit
 import love.forte.simbot.component.onebot.v11.core.actor.OneBotMember
 import love.forte.simbot.component.onebot.v11.core.actor.OneBotMemberDeleteOption
 import love.forte.simbot.component.onebot.v11.core.actor.OneBotMemberRole
-import love.forte.simbot.component.onebot.v11.core.api.GetGroupMemberInfoResult
-import love.forte.simbot.component.onebot.v11.core.api.SetGroupAnonymousBanApi
-import love.forte.simbot.component.onebot.v11.core.api.SetGroupBanApi
-import love.forte.simbot.component.onebot.v11.core.api.SetGroupKickApi
+import love.forte.simbot.component.onebot.v11.core.api.*
 import love.forte.simbot.component.onebot.v11.core.bot.internal.OneBotBotImpl
 import love.forte.simbot.component.onebot.v11.core.bot.requestDataBy
 import love.forte.simbot.component.onebot.v11.core.internal.message.toReceipt
@@ -168,6 +165,14 @@ internal abstract class OneBotMemberImpl : OneBotMember {
         ).requestDataBy(bot)
     }
 
+    override suspend fun setNick(newNick: String?) {
+        SetGroupCardApi.create(
+            groupId = groupIdOrFailure,
+            userId = id,
+            card = newNick
+        )
+    }
+
     override fun toString(): String = "OneBotMember(id=$id, bot=${bot.id})"
 }