Skip to content

Commit

Permalink
Add detail for eventsub deletion docstring
Browse files Browse the repository at this point in the history
  • Loading branch information
chillymosh committed Jan 10, 2025
1 parent 64e98c3 commit 6dfebb7
Showing 1 changed file with 4 additions and 1 deletion.
5 changes: 4 additions & 1 deletion twitchio/client.py
Original file line number Diff line number Diff line change
Expand Up @@ -2393,6 +2393,8 @@ async def delete_eventsub_subscription(self, id: str, *, token_for: str | Partia
id: str
The ID of the eventsub subscription to delete.
token_for: str | PartialUser | None
Do not pass this if you wish to delete webhook subscriptions, which are what usually require deleting.
For websocket subscriptions, provide the user ID, or PartialUser, associated with the subscription.
"""
Expand All @@ -2406,8 +2408,9 @@ async def delete_all_eventsub_subscriptions(self, *, token_for: str | PartialUse
Parameters
----------
token_for: str | PartialUser | None
For websocket subscriptions, provide the user ID, or PartialUser, associated with the subscription.
Do not pass this if you wish to delete webhook subscriptions, which are what usually require deleting.
For websocket subscriptions, provide the user ID, or PartialUser, associated with the subscription.
"""
events = await self.fetch_eventsub_subscriptions(token_for=token_for)
async for sub in events.subscriptions:
Expand Down

0 comments on commit 6dfebb7

Please sign in to comment.