Skip to content

Commit e12f481

Browse files
committed
Update docs regarding bits voting
Update docs regarding bits voting
1 parent 3fcfd1f commit e12f481

File tree

2 files changed

+45
-0
lines changed

2 files changed

+45
-0
lines changed

twitchio/ext/eventsub/models.py

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -725,6 +725,12 @@ class PollChoice:
725725
The title of the choice
726726
bits_votes: :class:`int`
727727
How many votes were cast using Bits
728+
729+
.. warning::
730+
731+
Twitch have removed support for voting with bits.
732+
This will return as 0
733+
728734
channel_points_votes: :class:`int`
729735
How many votes were cast using Channel Points
730736
votes: :class:`int`
@@ -751,6 +757,12 @@ class BitsVoting:
751757
Whether users can use Bits to vote on the poll
752758
amount_per_vote: :class:`int`
753759
How many Bits are required to cast an extra vote
760+
761+
.. warning::
762+
763+
Twitch have removed support for voting with bits.
764+
This will return as False and 0 respectively
765+
754766
"""
755767

756768
__slots__ = "is_enabled", "amount_per_vote"
@@ -815,6 +827,11 @@ class PollBeginProgressData(EventData):
815827
The choices in the poll
816828
bits_voting: :class:`BitsVoting`
817829
Information on voting on the poll with Bits
830+
831+
.. warning::
832+
833+
Twitch have removed support for voting with bits.
834+
818835
channel_points_voting: :class:`ChannelPointsVoting`
819836
Information on voting on the poll with Channel Points
820837
started_at: :class:`datetime.datetime`
@@ -862,6 +879,11 @@ class PollEndData(EventData):
862879
The choices in the poll
863880
bits_voting: :class:`BitsVoting`
864881
Information on voting on the poll with Bits
882+
883+
.. warning::
884+
885+
Twitch have removed support for voting with bits.
886+
865887
channel_points_voting: :class:`ChannelPointsVoting`
866888
Information on voting on the poll with Channel Points
867889
status: :class:`PollStatus`

twitchio/models.py

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1373,6 +1373,11 @@ class Poll:
13731373
"""
13741374
Represents a list of Polls for a broadcaster / channel
13751375
1376+
.. note::
1377+
1378+
Twitch have removed support for voting with bits.
1379+
By default bits_votes, bits_voting_enabled and bits_per_vote will be received as either 0 or False.
1380+
13761381
Attributes
13771382
-----------
13781383
id: :class:`str`
@@ -1385,8 +1390,20 @@ class Poll:
13851390
The poll choices.
13861391
bits_voting_enabled: :class:`bool`
13871392
Indicates if Bits can be used for voting.
1393+
1394+
.. warning::
1395+
1396+
Twitch have removed support for voting with bits.
1397+
This will return as False
1398+
13881399
bits_per_vote: :class:`int`
13891400
Number of Bits required to vote once with Bits.
1401+
1402+
.. warning::
1403+
1404+
Twitch have removed support for voting with bits.
1405+
This will return as 0
1406+
13901407
channel_points_voting_enabled: :class:`bool`
13911408
Indicates if Channel Points can be used for voting.
13921409
channel_points_per_vote: :class:`int`
@@ -1449,6 +1466,12 @@ class PollChoice:
14491466
Number of votes received via Channel Points.
14501467
bits_votes: :class:`int`
14511468
Number of votes received via Bits.
1469+
1470+
.. warning::
1471+
1472+
Twitch have removed support for voting with bits.
1473+
This will return as 0
1474+
14521475
"""
14531476

14541477
__slots__ = ("id", "title", "votes", "channel_points_votes", "bits_votes")

0 commit comments

Comments
 (0)