From 6f11885a5b9f282caf96e2803f7a9df2891ea194 Mon Sep 17 00:00:00 2001 From: Moian <56097585+moian98@users.noreply.github.com> Date: Tue, 2 May 2023 15:48:38 +0800 Subject: [PATCH 1/4] =?UTF-8?q?feat:=20pythonsdk=20=E8=A1=A5=E5=85=85?= =?UTF-8?q?=E8=8E=B7=E5=8F=96=E9=A2=91=E9=81=93=E8=BA=AB=E4=BB=BD=E7=BB=84?= =?UTF-8?q?=E7=9A=84=E6=88=90=E5=91=98=E5=88=97=E8=A1=A8API=E6=96=87?= =?UTF-8?q?=E6=A1=A3?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .../api/member/get_guild_role_members.md | 62 +++++++++++++++++++ 1 file changed, 62 insertions(+) create mode 100644 docs/develop/pythonsdk/api/member/get_guild_role_members.md diff --git a/docs/develop/pythonsdk/api/member/get_guild_role_members.md b/docs/develop/pythonsdk/api/member/get_guild_role_members.md new file mode 100644 index 00000000..25ca7009 --- /dev/null +++ b/docs/develop/pythonsdk/api/member/get_guild_role_members.md @@ -0,0 +1,62 @@ +# 获取频道身份组的成员列表 + +获取频道下指定身份组的成员列表。 + + + +## 使用示例 + +```python +import qqbot + +token = qqbot.Token({appid}, {token}) +api = qqbot.GuildMemberAPI(token, False) +members = api.get_guild_role_members(guild_id, role_id, query_params) +``` + +## 参数说明 + +| 字段名 | 必填 | 类型 | 描述 | +| ----------- | ---- | --------------------------- | -------- | +| guild_id | 是 | string | 频道 ID | +| role_id | 是 | string | 身份组 ID | +| start_index | 否 | string | 上一次回包中 next， 如果是第一次请求填 0，默认为 0 | +| limit | 否 | number | 分页大小，1-400，默认是 1 | + +## 返回说明 + +| 字段名 | 类型 | 描述 | +| -------- | ------- | ------------ | +| data | [Member](#Member) | 一组用户信息对象 | +| next | string | 下一次请求的分页标识 | + + +## Member + +| 字段名 | 类型 | 描述 | +| --------- | ------------- | -------------------------------------------------------------------------------------------- | +| user | [User](#user) | 用户的频道基础信息，只有成员相关接口中会填充此信息 | +| nick | string | 用户在频道内的昵称 | +| joined_at | string | 用户加入频道的时间，是个 `ISO8601 timestamp` 字符串，例："2021-11-23T15:16:48+08:00" | + +## 返回示例 + +`data`： + +```json +{ + "data": [ + { + "user": { + "id": "用户 ID", + "username": "用户名", + "avatar": "用户头像地址", + "bot": false + }, + "nick": "", + "joined_at": "2021-11-23T15:16:48+08:00" + } + ] + "next": "0" +} +``` From ea60ad282b9d254683c8cdb928adce37f4c638f4 Mon Sep 17 00:00:00 2001 From: Moian <56097585+moian98@users.noreply.github.com> Date: Tue, 2 May 2023 15:55:00 +0800 Subject: [PATCH 2/4] Update README.md --- docs/develop/pythonsdk/changelog/README.md | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/docs/develop/pythonsdk/changelog/README.md b/docs/develop/pythonsdk/changelog/README.md index a311da41..988f507b 100644 --- a/docs/develop/pythonsdk/changelog/README.md +++ b/docs/develop/pythonsdk/changelog/README.md @@ -1,5 +1,9 @@ # PythonSDK更新日志 +## 2023-05-02 + +* feat: pythonsdk 添加获取频道身份组的成员列表的接口 ([6f11885](https://github.com/moian98/bot-docs/commit/6f11885a5b9f282caf96e2803f7a9df2891ea194)) + ## 2022-06-17 * feat: 完善ws事件中Message数据的构建 ([9564cb2](https://github.com/tencent-connect/botpy/pull/103/commits/9564cb2858833fb8de442123226fe7a46f743fe6)) @@ -69,4 +73,4 @@ ## 2021-12-25 * fix: 修改import规范 ([37099b3](https://github.com/tencent-connect/botpy/commit/37099b37fb0047bae2136f1944c6f12ae860ba68)) -* [init]初始化框架代码 ([4413bd5](https://github.com/tencent-connect/botpy/commit/4413bd5152da1e51fba0551f86d4560c55afecf8)) \ No newline at end of file +* [init]初始化框架代码 ([4413bd5](https://github.com/tencent-connect/botpy/commit/4413bd5152da1e51fba0551f86d4560c55afecf8)) From 5cf4a1c2f6d3c84a68b1e931932573b6bc2e60be Mon Sep 17 00:00:00 2001 From: Moian <56097585+moian98@users.noreply.github.com> Date: Tue, 2 May 2023 15:57:39 +0800 Subject: [PATCH 3/4] Update README.md --- docs/develop/pythonsdk/changelog/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/develop/pythonsdk/changelog/README.md b/docs/develop/pythonsdk/changelog/README.md index 988f507b..dca5c088 100644 --- a/docs/develop/pythonsdk/changelog/README.md +++ b/docs/develop/pythonsdk/changelog/README.md @@ -2,7 +2,7 @@ ## 2023-05-02 -* feat: pythonsdk 添加获取频道身份组的成员列表的接口 ([6f11885](https://github.com/moian98/bot-docs/commit/6f11885a5b9f282caf96e2803f7a9df2891ea194)) +* feat: pythonsdk 添加获取频道身份组的成员列表的接口 ([582c2b1](https://github.com/tencent-connect/botpy/pull/135/commits/582c2b185a3264c0b6dcbfb91128f127559dff7d)) ## 2022-06-17 From 8501c6bf6b67fd12b5929694d123e9f46c45ba94 Mon Sep 17 00:00:00 2001 From: Moian <56097585+moian98@users.noreply.github.com> Date: Tue, 2 May 2023 16:07:21 +0800 Subject: [PATCH 4/4] Update get_guild_role_members.md --- .../pythonsdk/api/member/get_guild_role_members.md | 14 ++++++++++---- 1 file changed, 10 insertions(+), 4 deletions(-) diff --git a/docs/develop/pythonsdk/api/member/get_guild_role_members.md b/docs/develop/pythonsdk/api/member/get_guild_role_members.md index 25ca7009..50d2e945 100644 --- a/docs/develop/pythonsdk/api/member/get_guild_role_members.md +++ b/docs/develop/pythonsdk/api/member/get_guild_role_members.md @@ -7,11 +7,17 @@ ## 使用示例 ```python -import qqbot +import botpy +from botpy.message import Message + +class MyClient(botpy.Client): + async def on_at_message_create(self, message: Message): + await self.api.get_guild_role_member(guild_id="xxxx", role_id="xxxx") + +intents = botpy.Intents(public_guild_messages=True) +client = MyClient(intents=intents) +client.run(appid={appid}, token={token}) -token = qqbot.Token({appid}, {token}) -api = qqbot.GuildMemberAPI(token, False) -members = api.get_guild_role_members(guild_id, role_id, query_params) ``` ## 参数说明