Skip to content

Commit

Permalink
update docs with required intents to get raw poll events
Browse files Browse the repository at this point in the history
  • Loading branch information
Snipy7374 committed Aug 20, 2024
1 parent cc22623 commit 66b780c
Showing 1 changed file with 12 additions and 0 deletions.
12 changes: 12 additions & 0 deletions docs/api/events.rst
Original file line number Diff line number Diff line change
Expand Up @@ -1330,6 +1330,12 @@ This section documents events related to Discord chat messages.
Called when a vote is added on a poll. Unlike :func:`on_poll_vote_add`, this is
called regardless of the guilds being in the internal guild cache or not.

This requires :attr:`Intents.guild_polls` or :attr:`Intents.dm_polls` to be enabled to receive events about polls sent in guilds or DMs.

.. note::

You can use :attr:`Intents.polls` to enable both :attr:`Intents.guild_polls` and :attr:`Intents.dm_polls` in one go.

:param payload: The raw event payload data.
:type payload: :class:`RawPollVoteActionEvent`

Expand All @@ -1338,6 +1344,12 @@ This section documents events related to Discord chat messages.
Called when a vote is removed on a poll. Unlike :func:`on_poll_vote_remove`, this is
called regardless of the guilds being in the internal guild cache or not.

This requires :attr:`Intents.guild_polls` or :attr:`Intents.dm_polls` to be enabled to receive events about polls sent in guilds or DMs.

.. note::

You can use :attr:`Intents.polls` to enable both :attr:`Intents.guild_polls` and :attr:`Intents.dm_polls` in one go.

:param payload: The raw event payload data.
:type payload: :class:`RawPollVoteActionEvent`

Expand Down

0 comments on commit 66b780c

Please sign in to comment.