Skip to content

Commit

Permalink
Docs fixes
Browse files Browse the repository at this point in the history
  • Loading branch information
chillymosh committed Dec 24, 2024
1 parent 4793f6a commit 20c232c
Showing 1 changed file with 28 additions and 28 deletions.
56 changes: 28 additions & 28 deletions twitchio/eventsub/subscriptions.py
Original file line number Diff line number Diff line change
Expand Up @@ -2666,20 +2666,20 @@ class ShieldModeBeginSubscription(SubscriptionPayload):
This event informs the subscriber that the broadcaster's moderation settings were changed based on the broadcaster's Shield Mode configuration settings.
Parameters
----------
broadcaster_user_id: str | PartialUser
The ID, or PartialUser, of the broadcaster to subscribe to.
moderator_user_id: str | PartialUser
The ID, or PartialUser, of a moderator for the the broadcaster you are subscribing to. This could also be the broadcaster.
.. important::
Requires the ``moderator:read:shield_mode`` or ``moderator:manage:shield_mode`` scope.
- If you use webhooks, the moderator must have granted your app (client ID) one of the above permissions prior to your app subscribing to this subscription type.
- If you use WebSockets, the moderator's ID must match the user ID in the user access token.
Parameters
----------
broadcaster_user_id: str | PartialUser
The ID, or PartialUser, of the broadcaster to subscribe to.
moderator_user_id: str | PartialUser
The ID, or PartialUser, of a moderator for the the broadcaster you are subscribing to. This could also be the broadcaster.
Attributes
----------
condition: Condition
Expand Down Expand Up @@ -2712,20 +2712,20 @@ class ShieldModeEndSubscription(SubscriptionPayload):
This event informs the subscriber that the broadcaster's moderation settings were changed back to the broadcaster's previous moderation settings.
Parameters
----------
broadcaster_user_id: str | PartialUser
The ID, or PartialUser, of the broadcaster to subscribe to.
moderator_user_id: str | PartialUser
The ID, or PartialUser, of a moderator for the the broadcaster you are subscribing to. This could also be the broadcaster.
.. important::
Requires the ``moderator:read:shield_mode`` or ``moderator:manage:shield_mode`` scope.
- If you use webhooks, the moderator must have granted your app (client ID) one of the above permissions prior to your app subscribing to this subscription type.
- If you use WebSockets, the moderator's ID must match the user ID in the user access token.
Parameters
----------
broadcaster_user_id: str | PartialUser
The ID, or PartialUser, of the broadcaster to subscribe to.
moderator_user_id: str | PartialUser
The ID, or PartialUser, of a moderator for the the broadcaster you are subscribing to. This could also be the broadcaster.
Attributes
----------
condition: Condition
Expand Down Expand Up @@ -2756,13 +2756,6 @@ def condition(self) -> Condition:
class ShoutoutCreateSubscription(SubscriptionPayload):
"""The ``channel.shoutout.create`` subscription type sends a notification when the specified broadcaster sends a shoutout.
Parameters
----------
broadcaster_user_id: str | PartialUser
The ID, or PartialUser, of the broadcaster to subscribe to.
moderator_user_id: str | PartialUser
The ID, or PartialUser, of a moderator for the the broadcaster you are subscribing to. This could also be the broadcaster.
.. important::
Requires the ``moderator:read:shoutouts`` or ``moderator:manage:shoutouts`` scope.
Expand All @@ -2773,6 +2766,13 @@ class ShoutoutCreateSubscription(SubscriptionPayload):
.. note::
This is only sent if Twitch posts the Shoutout to the broadcaster's activity feed.
Parameters
----------
broadcaster_user_id: str | PartialUser
The ID, or PartialUser, of the broadcaster to subscribe to.
moderator_user_id: str | PartialUser
The ID, or PartialUser, of a moderator for the the broadcaster you are subscribing to. This could also be the broadcaster.
Attributes
----------
condition: Condition
Expand Down Expand Up @@ -2803,13 +2803,6 @@ def condition(self) -> Condition:
class ShoutoutReceiveSubscription(SubscriptionPayload):
"""The ``channel.shoutout.receive`` subscription type sends a notification when the specified broadcaster receives a shoutout.
Parameters
----------
broadcaster_user_id: str | PartialUser
The ID, or PartialUser, of the broadcaster to subscribe to.
moderator_user_id: str | PartialUser
The ID, or PartialUser, of a moderator for the the broadcaster you are subscribing to. This could also be the broadcaster.
.. important::
Requires the ``moderator:read:shoutouts`` or ``moderator:manage:shoutouts`` scope.
Expand All @@ -2820,6 +2813,13 @@ class ShoutoutReceiveSubscription(SubscriptionPayload):
.. note::
This is only sent if Twitch posts the Shoutout to the broadcaster's activity feed.
Parameters
----------
broadcaster_user_id: str | PartialUser
The ID, or PartialUser, of the broadcaster to subscribe to.
moderator_user_id: str | PartialUser
The ID, or PartialUser, of a moderator for the the broadcaster you are subscribing to. This could also be the broadcaster.
Attributes
----------
condition: Condition
Expand Down

0 comments on commit 20c232c

Please sign in to comment.