fix: 更新部分文档

zhinjs · Jul 17, 2024 · afc68af · afc68af
1 parent 47a989b
commit afc68af
Show file tree

Hide file tree

Showing 27 changed files with 486 additions and 244 deletions.
diff --git a/docs/.vitepress/config.mts b/docs/.vitepress/config.mts
@@ -14,21 +14,38 @@ export default defineConfig({
             }
         },
         editLink: {
-          pattern: 'https://github.com/lc-cn/kook-client/edit/main/docs/src/:path',
+          pattern: 'https://github.com/zhinjs/kook-client/edit/main/docs/src/:path',
           text: '修改'
         },
         nav: [
             { text: '开始', link: '/guide/start', activeMatch: '/guide/' },
             { text: '配置', link: '/config', activeMatch: '/config' },
             {
-                text: 'API',
-                activeMatch: '/api/',
+                text: '模块',
+                activeMatch: '/module/',
                 items: [
-                    { text: '服务器', link: '/api/guild' },
-                    { text: '频道', link: '/api/channel' },
-                    { text: '私聊', link: '/api/private' },
+                    { text: '客户端(Client)', link: '/module/client' },
+                    { text: '服务器(Guild)', link: '/module/guild' },
+                    { text: '角色(Role)', link: '/module/role' },
+                    { text: '频道(Channel)', link: '/module/channel' },
+                    { text: '用户(User)', link: '/module/user' },
                 ]
             },
+            {
+              text:'消息段',
+              activeMatch:'/segment/',
+              items:[
+                  { text: '文本', link: '/segment/text' },
+                  { text: '表情', link: '/segment/face' },
+                  { text: '图片', link: '/segment/image' },
+                  { text: '音频', link: '/segment/audio' },
+                  { text: '视频', link: '/segment/video' },
+                  { text: '回复', link: '/segment/reply' },
+                  { text: 'At', link: '/segment/at' },
+                  { text: 'Markdown', link: '/segment/markdown' },
+                  { text: '卡片消息', link: '/segment/card' },
+              ]
+            },
             {
                 text: '事件',
                 activeMatch: '/event/',
@@ -37,7 +54,7 @@ export default defineConfig({
                     { text: '频道消息事件', link: '/event/channel' },
                 ]
             },
-            { text: '更新日志', link: 'https://github.com/lc-cn/kook-client/blob/master/CHANGELOG.md', target: '_blank', }
+            { text: '更新日志', link: 'https://github.com/zhinjs/kook-client/blob/master/CHANGELOG.md', target: '_blank', }
         ],
         sidebar: [
             {
@@ -63,16 +80,18 @@ export default defineConfig({
                 ]
             },
             {
-                text: '接口分组',
+                text: '模块定义',
                 items: [
-                    { text: '服务器', link: '/api/guild' },
-                    { text: '频道', link: '/api/channel' },
-                    { text: '私聊', link: '/api/private' },
+                    { text: '客户端(Client)', link: '/module/client' },
+                    { text: '服务器(Guild)', link: '/module/guild' },
+                    { text: '角色(Role)', link: '/module/role' },
+                    { text: '频道(Channel)', link: '/module/channel' },
+                    { text: '用户(User)', link: '/module/user' },
                 ]
             }
         ],
         footer: {
-            message: 'Released under the <a href="https://github.com/lc-cn/kook-client/blob/master/LICENSE">MIT License</a>.',
+            message: 'Released under the <a href="https://github.com/zhinjs/kook-client/blob/master/LICENSE">MIT License</a>.',
             copyright: 'Copyright © 2023-present <a href="https://github.com/lc-cn">lc-cn</a>'
         }
     },

diff --git a/docs/src/api/channel.md b/docs/src/api/channel.md
diff --git a/docs/src/api/common.md b/docs/src/api/common.md
diff --git a/docs/src/api/guild.md b/docs/src/api/guild.md
diff --git a/docs/src/api/private.md b/docs/src/api/private.md
diff --git a/docs/src/config.md b/docs/src/config.md
@@ -8,24 +8,6 @@ layout: doc
 |----------|---------------------|-----------------------|-------|
 | token    | string              | kook机器人的token 必填      | -     |
 | mode     | webhook\|websocket  | 接收方式 必填               | -     |
+| ignore | bot\|self| 消息忽略方式 必填             |-|
 | maxRetry | number              | 机器人与qq官方的通信端口时的最大重连次数 | 10    |
 | timeout  | number              | 机器人与请求官方接口的超时时间，单位毫秒  | 5000  |
-
-# intent
-
-| 值                             | 描述        |
-|-------------------------------|-----------|
-| GUILDS                        | 频道操作事件    |
-| GUILD_MEMBERS                 | 频道成员变更事件  |
-| GUILD_MESSAGES                | 私域频道消息事件  |
-| GUILD_MESSAGE_REACTIONS       | 频道消息表态事件  |
-| DIRECT_MESSAGE                | 频道私信事件    |
-| AUDIO_OR_LIVE_CHANNEL_MEMBERS | 音频或直播频道成员 |
-| C2C_MESSAGE_CREATE            | 私聊消息事件    |
-| GROUP_AT_MESSAGE_CREATE       | 群聊@消息事件   |
-| INTERACTION                   | 互动事件      |
-| MESSAGE_AUDIT                 | 消息审核事件    |
-| FORUMS_EVENTS                 | 论坛事件(仅私域) |
-| AUDIO_ACTIONS                 | 音频操作事件    |
-
-
diff --git a/docs/src/guide/instruction.md b/docs/src/guide/instruction.md
@@ -3,12 +3,12 @@ layout: doc
 ---
 # 简介
 ## 1. 什么是 “kook-client” ?
-`kook-client` 是基于 `NodeJS` 编写的 qq官方机器人 开发SDK，它提供了一套 API 和工具，可以帮助开发者构建和使用 QQ 机器人。
+`kook-client` 是基于 `NodeJS` 编写的 KOOK 机器人 开发SDK，它提供了一套 API 和工具，可以帮助开发者构建和使用 QQ 机器人。
 
 使用 `kook-client`，开发者可以通过编写 JavaScript 或 TypeScript 代码来实现 QQ 群机器人的功能，如接收和发送消息、管理频道成员、频道信息等。该 SDK 提供了丰富的功能和事件回调，方便开发者根据自己的需求进行扩展和定制。
 
-借助 `kook-client`，开发者可以快速构建自己的 QQ 群机器人，并利用机器人在 QQ 群中实现自动化任务、消息处理、数据收集等功能。这对于频道管理、社区运营、消息推送等场景非常有用。
+借助 `kook-client`，开发者可以快速构建自己的 机器人，并利用机器人在 QQ 群中实现自动化任务、消息处理、数据收集等功能。这对于频道管理、社区运营、消息推送等场景非常有用。
 
-需要注意的是，`kook-client` 是一个第三方开发的 SDK，并非由 QQ 官方提供或支持。开发者可以根据自己的需求选择合适的 SDK 或工具来进行 QQ 群机器人的开发。
+需要注意的是，`kook-client` 是一个第三方开发的 SDK，并非由 官方提供或支持。开发者可以根据自己的需求选择合适的 SDK 或工具来进行机器人的开发。
 ## 2. 如何使用 “kook-client” ？
 见[快速开始](./start.md) 章节
diff --git a/docs/src/guide/start.md b/docs/src/guide/start.md
@@ -21,35 +21,25 @@ npm install kook-client
 const {Client} = require('kook-client');
 
 const client = new Client({
-	// 在这里配置你的 QQ 机器人的appid和secret等信息
-    appid: '你的 appid',
-    secret: '你的 secret',
-    intents:[ // 监听事件类型
-        // 'GROUP_AT_MESSAGE_CREATE', // 群聊@消息事件 没有群权限请注释
-	    'C2C_MESSAGE_CREATE', // 私聊事件 没有私聊权限请注释
-	    'GUILD_MESSAGES', // 私域机器人频道消息事件 公域机器人请注释
-	    'PUBLIC_GUILD_MESSAGES', // 公域机器人频道消息事件 私域机器人请注释
-	    'DIRECT_MESSAGE', // 频道私信事件
-	    'GUILD_MESSAGE_REACTIONS', // 频道消息表态事件
-	    'GUILDS', // 频道变更事件
-	    'GUILD_MEMBERS', // 频道成员变更事件
-	    'DIRECT_MESSAGE', // 频道私信事件
-    ]
+	// 在这里配置你的 机器人的token和连接模式等信息
+	ignore:'bot',
+	token:'你的机器人token',
+	mode:'websocket'
 });
 
 // 监听消息事件
-client.on('message', (event) => {
+client.on('message.channel', (event) => {
 	// 在这里处理消息
 	console.log('收到消息:', event.message);
 	// 回复消息
 	event.reply('hello world')
 });
 
 // 启动机器人
-client.start();
+client.connect();
 ```
 
-- 注意：在配置中，你需要填写你的 `appid`和 `secret`。请确保妥善保管你的账号信息，并遵循相关使用条款和隐私政策。
+- 注意：在配置中，你需要填写你的 `token`和 `mode`。请确保妥善保管token信息，并遵循相关使用条款和隐私政策。
 - 示例中的配置仅为基础配置，更多配置信息请查看 [配置项](../config.md) 章节
 
 
diff --git a/docs/src/index.md b/docs/src/index.md
@@ -3,14 +3,14 @@ layout: home
 
 hero:
   name: kook-client
-  text: 基于NodeJS的qq官方机器人开发SDK
+  text: 基于NodeJS的 KOOK 机器人开发SDK
   actions:
     - theme: brand
       text: 快速开始
       link: /guide/start
     - theme: alt
       text: View on GitHub
-      link: https://github.com/lc-cn/kook-client
+      link: https://github.com/zhinjs/kook-client
 features:
   - title: 上手简单
     details: 方法使用参考icqq设计，更容易上手

diff --git a/docs/src/module/channel.md b/docs/src/module/channel.md
@@ -0,0 +1,42 @@
+# 子频道
+## 获取频道列表
+- getChannelList
+- 将返回 [Channel](https://client.q.qq.com/wiki/develop/api-v2/server-inter/channel/manage/channel/model.html#channel)对象
+
+| 参数名 | 类型 | 是否必填 | 描述|
+|-----|----|------|----|
+| guild_id|string|是|服务器id|
+## Channel.Info
+```typescript
+export interface Info {
+    /**
+     * 频道id
+     */
+    id: string
+    /**
+     * 创建者id
+     */
+    user_id: string
+    /**
+     * 频道名称
+     */
+    /**
+     * 父分组频道id
+     */
+    parent_id?: string
+    name: string
+    /**
+     * 频道类型
+     */
+    type: ChannelType
+    /**
+     * 频道排序
+     */
+    level: number
+    /**
+     * 人数限制
+     */
+    limit_account: number
+    is_category?: boolean
+}
+```
diff --git a/docs/src/module/client.md b/docs/src/module/client.md
@@ -0,0 +1,112 @@
+# 客户端(Client)
+## 获取机器人信息
+- getSelfInfo():Promise\<[User.Info](./user.md#user-info)[]>
+
+| 参数名 | 类型 | 是否必填 | 描述|
+|-----|----|------|----|
+## 机器人上线
+- setOnline():Promise\<boolean>
+
+| 参数名 | 类型 | 是否必填 | 描述|
+|-----|----|------|----|
+## 机器人下线
+- setOffline():Promise\<boolean>
+
+| 参数名 | 类型 | 是否必填 | 描述|
+|-----|----|------|----|
+## 获取在线状态
+- getOnlineStatus():Promise\<{online:boolean,online_os:string[]}>
+
+| 参数名 | 类型 | 是否必填 | 描述|
+|-----|----|------|----|
+## 获取机器人加入的服务器列表
+- getGuildList()：Promise\<[Guild.Info](./guild.md#guild-info)[]>
+
+| 参数名 | 类型 | 是否必填 | 描述|
+|-----|----|------|----|
+## 获取指定服务器详情
+- getGuildList(guild_id)：Promise\<[Guild.Info](./guild.md#guild-info)>
+
+| 参数名 | 类型 | 是否必填 | 描述    |
+|-----|----|------|-------|
+| guild_id|string|true| 服务器id |
+## 获取指定服务器频道列表
+- getChannelList(guild_id)：Promise\<[Channel.Info](./channel.md#channel-info)[]>
+
+| 参数名 | 类型 | 是否必填 | 描述    |
+|-----|----|------|-------|
+| guild_id|string|true| 服务器id |
+## 获取指定服务器成员列表
+- getGuildUserList(guild_id,channel_id?)：Promise\<[User.Info](./user.md#user-info)[]>
+
+| 参数名        | 类型 | 是否必填  | 描述                 |
+|------------|----|-------|--------------------|
+| guild_id   |string| true  | 服务器id              |
+| channel_id |string| false | 频道id，传入则获取指定频道成员列表 |
+
+## 获取黑名单成员列表
+- getGuildUserList(guild_id)：Promise\<[Guild.BlackInfo](./guild.md#guild-blackinfo)[]>
+
+| 参数名        | 类型 | 是否必填  | 描述                 |
+|------------|----|-------|--------------------|
+| guild_id   |string| true  | 服务器id              |
+## 发送私聊消息
+- sendPrivateMsg(user_id,message,quote)：Promise\<Message.Ret>
+
+| 参数名     | 类型        | 是否必填  | 描述   |
+|---------|-----------|-------|------|
+| user_id | string    | true  | 用户id |
+| message | Sendable  | true  | 消息内容 |
+| quote   | Quoteable | false | 引用内容 |
+## 发送频道消息
+- sendChannelMsg(channel_id,message,quote)：Promise\<Message.Ret>
+
+| 参数名     | 类型        | 是否必填  | 描述   |
+|---------|-----------|-------|------|
+| channel_id | string    | true  | 频道id |
+| message | Sendable  | true  | 消息内容 |
+| quote   | Quoteable | false | 引用内容 |
+## 获取私聊消息
+- getPrivateMsg(channel_id,message_id)：Promise\<Message>
+
+| 参数名        | 类型        | 是否必填  | 描述   |
+|------------|-----------|-------|------|
+| user_id    | string    | true  | 用户id |
+| message_id | string    | true  | 消息id |
+## 获取频道消息
+- getChannelMsg(channel_id,message_id)：Promise\<Message>
+
+| 参数名        | 类型        | 是否必填  | 描述   |
+|------------|-----------|-------|------|
+| channel_id | string    | true  | 频道id |
+| message_id | string    | true  | 消息id |
+## 撤回私聊消息
+- recallPrivateMsg(channel_id,message_id)：Promise\<Message>
+
+| 参数名        | 类型        | 是否必填  | 描述   |
+|------------|-----------|-------|------|
+| user_id    | string    | true  | 用户id |
+| message_id | string    | true  | 消息id |
+## 撤回频道消息
+- recallChannelMsg(channel_id,message_id)：Promise\<Message>
+
+| 参数名        | 类型        | 是否必填  | 描述   |
+|------------|-----------|-------|------|
+| channel_id | string    | true  | 频道id |
+| message_id | string    | true  | 消息id |
+## 获取私聊聊天历史
+- getPrivateChatHistory(channel_id,message_id)：Promise\<Message[]>
+
+| 参数名        | 类型        | 是否必填  | 描述   |
+|------------|-----------|-------|------|
+| user_id    | string    | true  | 用户id |
+| message_id | string    | false | 消息id |
+## 获取频道聊天历史
+- getChannelChatHistory(channel_id,message_id)：Promise\<Message[]>
+
+| 参数名        | 类型        | 是否必填  | 描述   |
+|------------|-----------|-------|------|
+| channel_id | string    | true  | 频道id |
+| message_id | string    | false | 消息id |
+
+