Skip to content

Commit

Permalink
feat:新增'获取频道身份组成员的列表'API (#135)
Browse files Browse the repository at this point in the history
* 新增'获取频道身份组成员的列表'API

* 新增'获取频道身份组成员的列表'API
  • Loading branch information
moian98 committed May 17, 2023
1 parent ff6a654 commit 636f98a
Showing 1 changed file with 28 additions and 1 deletion.
29 changes: 28 additions & 1 deletion botpy/api.py
Expand Up @@ -3,7 +3,7 @@
# 异步api

from io import BufferedReader
from typing import Any, List, Union, BinaryIO
from typing import Any, List, Union, BinaryIO, Dict

from .flags import Permission
from .http import BotHttp, Route
Expand Down Expand Up @@ -247,6 +247,33 @@ async def get_guild_members(self, guild_id: str, after: str = "0", limit: int =
guild_id=guild_id,
)
return await self._http.request(route, params=params)

async def get_guild_role_members(
self, guild_id: str, role_id: str, start_index: str = "0", limit: int = 1
) -> Dict[str, Union[List[user.Member], str]]:
"""
获取频道身份组成员列表。
注意:该接口为私域机器人权限, 需要在管理端申请权限
Args:
guild_id (str): 频道 ID。
role_id (str): 身份组 ID。
start_index (str): 将上一次回包中next填入, 如果是第一次请求填 0,默认为 0。. Defaults to 0
limit (int): 分页大小,1-400。成员较多的频道尽量使用较大的limit值,以减少请求数。. Defaults to 1
Returns:
Dict[str, Union[List[user.Member], str]]
"""
params = {"start_index": start_index, "limit": limit}

route = Route(
"GET",
"/guilds/{guild_id}/roles/{role_id}/members",
guild_id=guild_id,
role_id=role_id
)
return await self._http.request(route, params=params)

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

0 comments on commit 636f98a

Please sign in to comment.