hikari.scheduled_events#
Application and entities that are used to describe guild scheduled events on Discord.
Module Contents#
- class hikari.scheduled_events.EventPrivacyLevel[source]#
Bases:
int
,hikari.internal.enums.Enum
Enum of the possible scheduled event privacy levels.
- class hikari.scheduled_events.ScheduledEvent[source]#
Bases:
hikari.snowflakes.Unique
Base class for scheduled events.
- property image_url: hikari.files.URL | None[source]#
Cover image for this scheduled event, if set.
- app: hikari.traits.RESTAware[source]#
Client application that models may use for procedures.
- creator: hikari.users.User | None[source]#
The user who created the scheduled event.
This will only be set for event created after 2021-10-25.
- end_time: datetime.datetime | None[source]#
When the event is scheduled to end, if set.
- entity_type: ScheduledEventType[source]#
The type of entity this scheduled event is associated with.
- guild_id: hikari.snowflakes.Snowflake[source]#
ID of the guild this scheduled event belongs to.
- id: hikari.snowflakes.Snowflake[source]#
ID of the scheduled event.
- privacy_level: EventPrivacyLevel[source]#
Privacy level of the scheduled event.
This restricts who can view and join the scheduled event.
- start_time: datetime.datetime[source]#
When the event is scheduled to start.
- status: ScheduledEventStatus[source]#
Status of the scheduled event.
- user_count: int | None[source]#
The number of users that have subscribed to the event.
This will be
None
on gateway events when creating and editing a scheduled event.
- make_image_url(*, ext='png', size=4096)[source]#
Generate the cover image for this scheduled event, if set.
- Parameters:
- Returns:
typing.Optional
[hikari.files.URL
]The URL, or
None
if no cover image is set.
- Raises:
ValueError
If
size
is not a power of two between 16 and 4096 (inclusive).
- class hikari.scheduled_events.ScheduledEventStatus[source]#
Bases:
int
,hikari.internal.enums.Enum
Enum of the scheduled event statuses.
- CANCELLED[source]#
Alias of
ScheduledEventStatus.CANCELED
.
- class hikari.scheduled_events.ScheduledEventType[source]#
Bases:
int
,hikari.internal.enums.Enum
Enum of the scheduled event types.
- class hikari.scheduled_events.ScheduledEventUser[source]#
A user who is subscribed to a scheduled event.
- event_id: hikari.snowflakes.Snowflake[source]#
ID of the scheduled event they’re subscribed to.
- member: hikari.guilds.Member | None[source]#
Their guild member object if they’re in the event’s guild.
- user: hikari.users.User[source]#
Object representing the user.
- class hikari.scheduled_events.ScheduledExternalEvent[source]#
Bases:
ScheduledEvent
A scheduled event that takes place outside of Discord.
- end_time: datetime.datetime[source]#
When the event is scheduled to end.
- class hikari.scheduled_events.ScheduledStageEvent[source]#
Bases:
ScheduledEvent
A scheduled event that takes place in a stage channel.
- channel_id: hikari.snowflakes.Snowflake[source]#
ID of the stage channel this event is scheduled in.
- class hikari.scheduled_events.ScheduledVoiceEvent[source]#
Bases:
ScheduledEvent
A scheduled event that takes place in a voice channel.
- channel_id: hikari.snowflakes.Snowflake[source]#
ID of the voice channel this scheduled event is in.