From 3e6b3633bdc245c7ecbc723ffa300c1d4954e276 Mon Sep 17 00:00:00 2001 From: DarkCWK Date: Mon, 11 Mar 2024 09:47:12 +0800 Subject: [PATCH] [Docs] Add Poke extend api --- docs/.vitepress/config.js | 4 +- docs/Lagrange.OneBot/API/Extend/index.md | 157 +++++++++++++---------- 2 files changed, 89 insertions(+), 72 deletions(-) diff --git a/docs/.vitepress/config.js b/docs/.vitepress/config.js index 2e1c6386..301c195f 100644 --- a/docs/.vitepress/config.js +++ b/docs/.vitepress/config.js @@ -138,7 +138,9 @@ module.exports = { { text: "私聊发送文件", link: '/Lagrange.OneBot/API/Extend/#私聊发送文件' }, { text: "获取群根目录文件列表", link: '/Lagrange.OneBot/API/Extend/#获取群根目录文件列表' }, { text: "获取群子目录文件列表", link: '/Lagrange.OneBot/API/Extend/#获取群子目录文件列表' }, - { text: "获取群文件资源链接", link: '/Lagrange.OneBot/API/Extend/#获取群文件资源链接' } + { text: "获取群文件资源链接", link: '/Lagrange.OneBot/API/Extend/#获取群文件资源链接' }, + { text: "好友戳一戳", link: '/Lagrange.OneBot/API/Extend/#好友戳一戳' }, + { text: "群组戳一戳", link: '/Lagrange.OneBot/API/Extend/#群组戳一戳' } ] }, ] diff --git a/docs/Lagrange.OneBot/API/Extend/index.md b/docs/Lagrange.OneBot/API/Extend/index.md index c74be23f..e5433a56 100644 --- a/docs/Lagrange.OneBot/API/Extend/index.md +++ b/docs/Lagrange.OneBot/API/Extend/index.md @@ -1,4 +1,4 @@ -# 拓展API +# 拓展 API ## 获取收藏表情 @@ -11,10 +11,9 @@ **响应数据** -| 字段 | 类型 | 说明 | -|---------------|--------------|----------| -| [RootElement] | List[string] | 表情的下载URL | - +| 字段 | 类型 | 说明 | +| ------------- | ------------ | -------------- | +| [RootElement] | List[string] | 表情的下载 URL | ## 获取好友历史消息记录 @@ -23,16 +22,16 @@ **参数** -| 字段 | 类型 | 说明 | -|--------------|--------|----------------| -| `user_id` | uint | 好友ID | -| `message_id` | int | 要获取的消息的最后一条的ID | -| `count` | int | 获取的消息数量 | +| 字段 | 类型 | 说明 | +| ------------ | ---- | --------------------------- | +| `user_id` | uint | 好友 ID | +| `message_id` | int | 要获取的消息的最后一条的 ID | +| `count` | int | 获取的消息数量 | **响应数据** -| 字段 | 类型 | 说明 | -|------------|----------------------------|-------| +| 字段 | 类型 | 说明 | +| ---------- | -------------------------- | ---------- | | `messages` | List[OneBotPrivateMessage] | 获取的消息 | ## 获取群组历史消息记录 @@ -42,20 +41,18 @@ **参数** -| 字段 | 类型 | 说明 | -|--------------|--------|----------------| -| `group_id` | uint | 群组ID | -| `message_id` | int | 要获取的消息的最后一条的ID | -| `count` | int | 获取的消息数量 | +| 字段 | 类型 | 说明 | +| ------------ | ---- | --------------------------- | +| `group_id` | uint | 群组 ID | +| `message_id` | int | 要获取的消息的最后一条的 ID | +| `count` | int | 获取的消息数量 | **响应数据** -| 字段 | 类型 | 说明 | -| --- |--------------------------|-------| +| 字段 | 类型 | 说明 | +| ---------- | ------------------------ | ---------- | | `messages` | List[OneBotGroupMessage] | 获取的消息 | - - ## 构造合并转发消息 **方法名**： @@ -63,29 +60,28 @@ **参数** -| 字段 | 类型 | 说明 | -| --- | --- | --- | +| 字段 | 类型 | 说明 | +| ---------- | ------------------------------------------------ | -------- | | `messages` | List[[Node](../../Segment/Extend/index.md#node)] | 参考下方 | 其中`OneBotSegment.node`的`data`部分要求如下 -| 字段 | 类型 | 说明 | -| --- | --- | --- | -| `name` | string | 自定义消息发送者昵称 | -| `uin` | string | 自定义消息发送者QQ号 | -| `content` | List[OneBotSegment] | 消息内容 | +| 字段 | 类型 | 说明 | +| --------- | ------------------- | ---------------------- | +| `name` | string | 自定义消息发送者昵称 | +| `uin` | string | 自定义消息发送者 QQ 号 | +| `content` | List[OneBotSegment] | 消息内容 | **响应数据** -| 字段 | 类型 | 说明 | -| --- | --- | --- | +| 字段 | 类型 | 说明 | +| ------- | ------ | ----- | | `resid` | string | Resid | :::tip 提示 **发送合并转发消息** -请使用标准消息发送API发送一个`"type": "forward", "id": Resid`的`OneBotSegment`消息 - +请使用标准消息发送 API 发送一个`"type": "forward", "id": Resid`的`OneBotSegment`消息 **参考代码** @@ -114,20 +110,18 @@ async def test_send_forward_message(target_id: int): **参数** -| 字段 | 类型 | 说明 | -| ---------- | ------------------------ | ------------------------------------------------------------ | -| `group_id` | uint | 群号 | +| 字段 | 类型 | 说明 | +| ---------- | ------------------------------------------------ | ---------------------------- | +| `group_id` | uint | 群号 | | `messages` | List[[Node](../../Segment/Extend/index.md#node)] | 自定义转发消息, 要求参看前文 | **响应数据** | 字段名 | 数据类型 | 说明 | | ------------ | -------- | ----------- | -| `message_id` | int | 消息 ID | +| `message_id` | int | 消息 ID | | `forward_id` | string | 转发消息 ID | - - ## 发送合并转发(好友) **方法名**： @@ -135,16 +129,16 @@ async def test_send_forward_message(target_id: int): **参数** -| 字段 | 类型 | 说明 | -| ---------- | ------------------------ | ------------------------------------------------------------ | -| `user_id` | uint | 好友QQ号 | +| 字段 | 类型 | 说明 | +| ---------- | ------------------------------------------------ | ---------------------------- | +| `user_id` | uint | 好友 QQ 号 | | `messages` | List[[Node](../../Segment/Extend/index.md#node)] | 自定义转发消息, 要求参看前文 | **响应数据** | 字段名 | 数据类型 | 说明 | | ------------ | -------- | ----------- | -| `message_id` | int | 消息 ID | +| `message_id` | int | 消息 ID | | `forward_id` | string | 转发消息 ID | ## 上传群文件 @@ -154,12 +148,12 @@ async def test_send_forward_message(target_id: int): **参数** -| 字段 | 类型 | 说明 | -| ---------- | ------ | ------------ | -| `group_id` | int | 群号 | -| `file` | string | **本地**文件路径 | -| `name` | string | 储存名称 | -| `folder` | string | 父目录ID（可选） | +| 字段 | 类型 | 说明 | +| ---------- | ------ | ----------------- | +| `group_id` | int | 群号 | +| `file` | string | **本地**文件路径 | +| `name` | string | 储存名称 | +| `folder` | string | 父目录 ID（可选） | ::: tip 提示 在不提供 `folder` 参数的情况下默认上传到根目录 @@ -172,11 +166,11 @@ async def test_send_forward_message(target_id: int): **参数** -| 字段 | 类型 | 说明 | -| --------- | ------ | ------------ | -| `user_id` | int | 对方 QQ 号 | +| 字段 | 类型 | 说明 | +| --------- | ------ | ---------------- | +| `user_id` | int | 对方 QQ 号 | | `file` | string | **本地**文件路径 | -| `name` | string | 文件名称 | +| `name` | string | 文件名称 | ## 获取群根目录文件列表 @@ -185,18 +179,17 @@ async def test_send_forward_message(target_id: int): **参数** -| 字段 | 类型 | 说明 | -| ---------- | ----- | ---- | -| `group_id` | int | 群号 | +| 字段 | 类型 | 说明 | +| ---------- | ---- | ---- | +| `group_id` | int | 群号 | **响应数据** -| 字段 | 类型 | 说明 | -| --------- | -------- | ---------- | -| `files` | List[[File](../../Segment/Extend/index.md#file)] | 文件列表 | +| 字段 | 类型 | 说明 | +| --------- | ---------------------------------------------------- | ---------- | +| `files` | List[[File](../../Segment/Extend/index.md#file)] | 文件列表 | | `folders` | List[[Folder](../../Segment/Extend/index.md#folder)] | 文件夹列表 | - ## 获取群子目录文件列表 **方法名**： @@ -204,19 +197,18 @@ async def test_send_forward_message(target_id: int): **参数** -| 字段 | 类型 | 说明 | -| ----------- | ------ | --------------------------- | -| `group_id` | int | 群号 | -| `folder_id` | string | 文件夹ID 参考 `Folder` 对象 | +| 字段 | 类型 | 说明 | +| ----------- | ------ | ---------------------------- | +| `group_id` | int | 群号 | +| `folder_id` | string | 文件夹 ID 参考 `Folder` 对象 | **响应数据** -| 字段 | 类型 | 说明 | -| --------- | -------- | ---------- | -| `files` | List[[File](../../Segment/Extend/index.md#file)] | 文件列表 | +| 字段 | 类型 | 说明 | +| --------- | ---------------------------------------------------- | ---------- | +| `files` | List[[File](../../Segment/Extend/index.md#file)] | 文件列表 | | `folders` | List[[Folder](../../Segment/Extend/index.md#folder)] | 文件夹列表 | - ## 获取群文件资源链接 **方法名**： @@ -224,10 +216,10 @@ async def test_send_forward_message(target_id: int): **参数** -| 字段 | 类型 | 说明 | -| ---------- | ------ | ------------------------- | -| `group_id` | int | 群号 | -| `file_id` | string | 文件ID | +| 字段 | 类型 | 说明 | +| ---------- | ------ | -------- | +| `group_id` | int | 群号 | +| `file_id` | string | 文件 ID | | `busid` | int | 文件类型 | **响应数据** @@ -235,3 +227,26 @@ async def test_send_forward_message(target_id: int): | 字段 | 类型 | 说明 | | ----- | ------ | ------------ | | `url` | string | 文件下载链接 | + +## 好友戳一戳 + +**方法名**： +`friend_poke` + +**参数** + +| 字段 | 类型 | 说明 | +| --------- | ---- | ---------- | +| `user_id` | int | 对方 QQ 号 | + +## 群组戳一戳 + +**方法名**： +`group_poke` + +**参数** + +| 字段 | 类型 | 说明 | +| ---------- | ---- | ---------- | +| `group_id` | int | 群号 | +| `user_id` | int | 对方 QQ 号 | \ No newline at end of file