feat: get_all_owned メソッドを追加

pull/109/head
yupix 7 months ago
parent 787813ecbc
commit 9439ef5a3e
No known key found for this signature in database
GPG Key ID: 2FF705F5C56D9C06

@ -589,23 +589,23 @@ class ChannelActions(ClientChannelActions):
async def owned(
self, since_id: str | None = None, until_id: str | None = None, limit: int = 5
) -> list[Channel]:
"""Get owned channels
"""自分が所有しているチャンネル一覧を取得します
Endpoint: `/api/channels/owned`
Parameters
----------
since_id : str, optional
Since ID, by default None
指定したチャンネルIDよりも後のチャンネルを取得します, default=None
until_id : str, optional
Until ID, by default None
指定したチャンネルIDよりも前のチャンネルを取得します, default=None
limit : int, optional
Limit, by default 5
一度に取得するチャンネルの数, default=5
Returns
-------
list[Channel]
List of owned channels
取得した自分が所有しているチャンネルのリスト
"""
data = {"sinceId": since_id, "untilId": until_id, "limit": limit}
@ -616,6 +616,38 @@ class ChannelActions(ClientChannelActions):
Channel(raw_channel=raw_channel, client=self._client) for raw_channel in raw_channels
]
async def get_all_owned(
self, since_id: str | None = None, until_id: str | None = None, limit: int = 5
) -> AsyncGenerator[Channel, None]:
"""自分が所有しているすべてのチャンネルを取得します
Endpoint: `/api/channels/owned`
Parameters
----------
since_id : str, optional
指定したチャンネルIDよりも後のチャンネルを取得します, default=None
until_id : str, optional
指定したチャンネルIDよりも前のチャンネルを取得します, default=None
limit : int, optional
一度に取得するチャンネルの数, default=5
Returns
-------
AsyncGenerator[Channel, None]
取得した自分が所有しているチャンネル
"""
body = {"sinceId": since_id, "untilId": until_id, "limit": limit}
pagination = Pagination[IChannel](
self._session, Route("POST", "/api/channels/owned"), json=body, auth=True
)
while pagination.is_final is False:
for raw_channel in await pagination.next():
yield Channel(raw_channel=raw_channel, client=self._client)
async def show(self, channel_id: str) -> Channel:
"""Show a channel

Loading…
Cancel
Save