From 6bd09ee6a80e80b87e030864e3b952768b35d7f9 Mon Sep 17 00:00:00 2001
From: ForteScarlet <ForteScarlet@163.com>
Date: Thu, 20 Jun 2024 00:30:23 +0800
Subject: [PATCH] =?UTF-8?q?Bot=E9=83=A8=E5=88=86=E6=96=87=E6=A1=A3?=
 =?UTF-8?q?=E5=86=85=E5=AE=B9?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

---
 Writerside/topics/onebot11-OneBotBot.md       | 76 ++++++++++++++++++-
 .../onebot/v11/core/bot/OneBotBot.kt          |  2 +-
 2 files changed, 76 insertions(+), 2 deletions(-)

diff --git a/Writerside/topics/onebot11-OneBotBot.md b/Writerside/topics/onebot11-OneBotBot.md
index cbc50e2..32cca1d 100644
--- a/Writerside/topics/onebot11-OneBotBot.md
+++ b/Writerside/topics/onebot11-OneBotBot.md
@@ -1,3 +1,77 @@
+---
+switcher-label: JavaAPI风格
+---
+
+<show-structure depth="2"/>
+
 # OneBotBot
 
-TODO
+表示一个 OneBot 的 bot 客户端实例，实现 `Bot`，由 `OneBotBotManager` 注册产生。
+
+## Bot
+
+`OneBot` 实现simbot标准接口 `Bot`，提供可支持的属性或能力。
+
+<deflist>
+<def id="prop-id" title="id">
+
+配置中提供的 `botUniqueId` ，
+用与 `OneBotBotManager` 中作为唯一标识。
+</def>
+<def id="prop-isMe" title="isMe(ID)">
+
+判断提供的 `ID` 是否为自己。
+首先依据 `id` 属性，如果内部的 `userId` 已经初始化，
+则也会依据 `userId` 进行判断。
+
+</def>
+<def id="prop-name" title="name">
+
+Bot自己的用户名。需要 `start` 后才会初始化，
+否则获取会抛出异常。
+
+</def>
+<def id="prop-contactRelation" title="contactRelation">
+
+联系人相关操作，即好友相关的关系操作。
+
+</def>
+<def id="prop-groupRelation" title="groupRelation">
+
+与群聊相关的操作。
+
+</def>
+<def id="prop-guildRelation" title="guildRelation">
+
+OneBot11协议不支持 `Guild` (即频道) 相关的操作，始终得到 `null`。
+
+</def>
+<def id="prop-start" title="start()">
+
+</def>
+</deflist>
+
+除了上述的属性和API，`OneBotBot` 还提供了一些额外的内容：
+
+<deflist>
+<def id="prop-decoderJson" title="decoderJson"></def>
+<def id="prop-configuration" title="configuration"></def>
+<def id="prop-apiClient" title="apiClient"></def>
+<def id="prop-apiHost" title="apiHost"></def>
+<def id="prop-accessToken" title="accessToken"></def>
+<def id="prop-userId" title="userId"></def>
+<def id="prop-queryLoginInfo" title="queryLoginInfo()"></def>
+<def id="prop-getCookies" title="getCookies(...)"></def>
+<def id="prop-getCredentials" title="getCredentials(...)"></def>
+<def id="prop-getCsrfToken" title="getCsrfToken()"></def>
+</deflist>
+
+### 关系对象
+
+即对好友和群的相关操作，通过 `contactRelation` 和 `groupRelation` 进行。
+
+#### OneBotBotFriendRelation
+#### OneBotBotGroupRelation
+
+
+<warning>TODO</warning>
diff --git a/simbot-component-onebot-v11/simbot-component-onebot-v11-core/src/commonMain/kotlin/love/forte/simbot/component/onebot/v11/core/bot/OneBotBot.kt b/simbot-component-onebot-v11/simbot-component-onebot-v11-core/src/commonMain/kotlin/love/forte/simbot/component/onebot/v11/core/bot/OneBotBot.kt
index ef9bd87..25bd56a 100644
--- a/simbot-component-onebot-v11/simbot-component-onebot-v11-core/src/commonMain/kotlin/love/forte/simbot/component/onebot/v11/core/bot/OneBotBot.kt
+++ b/simbot-component-onebot-v11/simbot-component-onebot-v11-core/src/commonMain/kotlin/love/forte/simbot/component/onebot/v11/core/bot/OneBotBot.kt
@@ -43,7 +43,7 @@ import kotlin.jvm.JvmSynthetic
 
 
 /**
- * 一个 OneBot协议的 [Bot]。
+ * 一个 OneBot 协议的 [Bot]。
  *
  * ### Bot 的终止
  * Bot的运行状态 ([isActive]) 可能会因为一些原因被更改：