Skip to content

hikari.events.poll_events#

Events related to polls.

BasePollVoteEvent #

Bases: ShardEvent

Event base for any event that involves a user voting on a poll.

answer_id class-attribute instance-attribute #

answer_id: int = attrs.field()

ID of the answer that the user voted for.

app class-attribute instance-attribute #

app: RESTAware = attrs.field(
    metadata={attrs_extensions.SKIP_DEEP_COPY: True}
)

App instance for this application.

channel_id class-attribute instance-attribute #

channel_id: Snowflake = attrs.field()

ID of the channel that the poll is in.

guild_id class-attribute instance-attribute #

guild_id: Snowflake | None = attrs.field()

ID of the guild that the poll is in.

message_id class-attribute instance-attribute #

message_id: Snowflake = attrs.field()

ID of the message that the poll is in.

shard class-attribute instance-attribute #

shard: GatewayShard = attrs.field(
    metadata={attrs_extensions.SKIP_DEEP_COPY: True}
)

Shard that received this event.

user_id class-attribute instance-attribute #

user_id: Snowflake = attrs.field()

ID of the user that added their vote to the poll.

PollVoteCreateEvent #

Bases: BasePollVoteEvent

Event that is fired when a user add their vote to a poll.

If the poll allows multiple selection, one event will be fired for each vote.

PollVoteDeleteEvent #

Bases: BasePollVoteEvent

Event that is fired when a user remove their vote to a poll.

If the poll allows multiple selection, one event will be fired for each vote.