Skip to content

Commit 636f98a

Browse files
authored
feat:新增'获取频道身份组成员的列表'API (#135)
* 新增'获取频道身份组成员的列表'API * 新增'获取频道身份组成员的列表'API
1 parent ff6a654 commit 636f98a

File tree

1 file changed

+28
-1
lines changed

1 file changed

+28
-1
lines changed

botpy/api.py

Lines changed: 28 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
# 异步api
44

55
from io import BufferedReader
6-
from typing import Any, List, Union, BinaryIO
6+
from typing import Any, List, Union, BinaryIO, Dict
77

88
from .flags import Permission
99
from .http import BotHttp, Route
@@ -247,6 +247,33 @@ async def get_guild_members(self, guild_id: str, after: str = "0", limit: int =
247247
guild_id=guild_id,
248248
)
249249
return await self._http.request(route, params=params)
250+
251+
async def get_guild_role_members(
252+
self, guild_id: str, role_id: str, start_index: str = "0", limit: int = 1
253+
) -> Dict[str, Union[List[user.Member], str]]:
254+
"""
255+
获取频道身份组成员列表。
256+
257+
注意:该接口为私域机器人权限, 需要在管理端申请权限
258+
259+
Args:
260+
guild_id (str): 频道 ID。
261+
role_id (str): 身份组 ID。
262+
start_index (str): 将上一次回包中next填入, 如果是第一次请求填 0,默认为 0。. Defaults to 0
263+
limit (int): 分页大小,1-400。成员较多的频道尽量使用较大的limit值,以减少请求数。. Defaults to 1
264+
265+
Returns:
266+
Dict[str, Union[List[user.Member], str]]
267+
"""
268+
params = {"start_index": start_index, "limit": limit}
269+
270+
route = Route(
271+
"GET",
272+
"/guilds/{guild_id}/roles/{role_id}/members",
273+
guild_id=guild_id,
274+
role_id=role_id
275+
)
276+
return await self._http.request(route, params=params)
250277

251278
async def get_voice_members(self, channel_id: str) -> List[user.Member]:
252279
"""

0 commit comments

Comments
 (0)