hikari.scheduled_events
#
Application and entities that are used to describe guild scheduled events on Discord.
ScheduledEvent
#
Bases: Unique
Base class for scheduled events.
app
class-attribute
instance-attribute
#
Client application that models may use for procedures.
creator
class-attribute
instance-attribute
#
The user who created the scheduled event.
This will only be set for event created after 2021-10-25.
description
class-attribute
instance-attribute
#
Description of the scheduled event.
end_time
class-attribute
instance-attribute
#
When the event is scheduled to end, if set.
entity_type
class-attribute
instance-attribute
#
entity_type: ScheduledEventType = field(hash=False, repr=True)
The type of entity this scheduled event is associated with.
guild_id
class-attribute
instance-attribute
#
ID of the guild this scheduled event belongs to.
id
class-attribute
instance-attribute
#
ID of the scheduled event.
image_hash
class-attribute
instance-attribute
#
Hash of the image used for the scheduled event, if set.
name
class-attribute
instance-attribute
#
Name of the scheduled event.
privacy_level
class-attribute
instance-attribute
#
privacy_level: EventPrivacyLevel = field(hash=False, repr=False)
Privacy level of the scheduled event.
This restricts who can view and join the scheduled event.
start_time
class-attribute
instance-attribute
#
When the event is scheduled to start.
status
class-attribute
instance-attribute
#
status: ScheduledEventStatus = field(hash=False, repr=True)
Status of the scheduled event.
user_count
class-attribute
instance-attribute
#
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
#
Generate the cover image for this scheduled event, if set.
PARAMETER | DESCRIPTION |
---|---|
ext |
The extension to use for this URL.
supports
TYPE:
|
size |
The size to set for the URL.
Can be any power of two between
TYPE:
|
RETURNS | DESCRIPTION |
---|---|
Optional[URL]
|
The URL, or |
RAISES | DESCRIPTION |
---|---|
ValueError
|
If |
ScheduledEventStatus
#
ScheduledEventType
#
ScheduledEventUser
#
ScheduledExternalEvent
#
Bases: ScheduledEvent
A scheduled event that takes place outside of Discord.
app
class-attribute
instance-attribute
#
Client application that models may use for procedures.
creator
class-attribute
instance-attribute
#
The user who created the scheduled event.
This will only be set for event created after 2021-10-25.
description
class-attribute
instance-attribute
#
Description of the scheduled event.
end_time
class-attribute
instance-attribute
#
When the event is scheduled to end.
entity_type
class-attribute
instance-attribute
#
entity_type: ScheduledEventType = field(hash=False, repr=True)
The type of entity this scheduled event is associated with.
guild_id
class-attribute
instance-attribute
#
ID of the guild this scheduled event belongs to.
id
class-attribute
instance-attribute
#
ID of the scheduled event.
image_hash
class-attribute
instance-attribute
#
Hash of the image used for the scheduled event, if set.
location
class-attribute
instance-attribute
#
The location of the scheduled event.
Note
There is no strict format for this field, and it will likely be a user friendly string.
name
class-attribute
instance-attribute
#
Name of the scheduled event.
privacy_level
class-attribute
instance-attribute
#
privacy_level: EventPrivacyLevel = field(hash=False, repr=False)
Privacy level of the scheduled event.
This restricts who can view and join the scheduled event.
start_time
class-attribute
instance-attribute
#
When the event is scheduled to start.
status
class-attribute
instance-attribute
#
status: ScheduledEventStatus = field(hash=False, repr=True)
Status of the scheduled event.
user_count
class-attribute
instance-attribute
#
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
#
Generate the cover image for this scheduled event, if set.
PARAMETER | DESCRIPTION |
---|---|
ext |
The extension to use for this URL.
supports
TYPE:
|
size |
The size to set for the URL.
Can be any power of two between
TYPE:
|
RETURNS | DESCRIPTION |
---|---|
Optional[URL]
|
The URL, or |
RAISES | DESCRIPTION |
---|---|
ValueError
|
If |
ScheduledStageEvent
#
Bases: ScheduledEvent
A scheduled event that takes place in a stage channel.
app
class-attribute
instance-attribute
#
Client application that models may use for procedures.
channel_id
class-attribute
instance-attribute
#
ID of the stage channel this event is scheduled in.
creator
class-attribute
instance-attribute
#
The user who created the scheduled event.
This will only be set for event created after 2021-10-25.
description
class-attribute
instance-attribute
#
Description of the scheduled event.
end_time
class-attribute
instance-attribute
#
When the event is scheduled to end, if set.
entity_type
class-attribute
instance-attribute
#
entity_type: ScheduledEventType = field(hash=False, repr=True)
The type of entity this scheduled event is associated with.
guild_id
class-attribute
instance-attribute
#
ID of the guild this scheduled event belongs to.
id
class-attribute
instance-attribute
#
ID of the scheduled event.
image_hash
class-attribute
instance-attribute
#
Hash of the image used for the scheduled event, if set.
name
class-attribute
instance-attribute
#
Name of the scheduled event.
privacy_level
class-attribute
instance-attribute
#
privacy_level: EventPrivacyLevel = field(hash=False, repr=False)
Privacy level of the scheduled event.
This restricts who can view and join the scheduled event.
start_time
class-attribute
instance-attribute
#
When the event is scheduled to start.
status
class-attribute
instance-attribute
#
status: ScheduledEventStatus = field(hash=False, repr=True)
Status of the scheduled event.
user_count
class-attribute
instance-attribute
#
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
#
Generate the cover image for this scheduled event, if set.
PARAMETER | DESCRIPTION |
---|---|
ext |
The extension to use for this URL.
supports
TYPE:
|
size |
The size to set for the URL.
Can be any power of two between
TYPE:
|
RETURNS | DESCRIPTION |
---|---|
Optional[URL]
|
The URL, or |
RAISES | DESCRIPTION |
---|---|
ValueError
|
If |
ScheduledVoiceEvent
#
Bases: ScheduledEvent
A scheduled event that takes place in a voice channel.
app
class-attribute
instance-attribute
#
Client application that models may use for procedures.
channel_id
class-attribute
instance-attribute
#
ID of the voice channel this scheduled event is in.
creator
class-attribute
instance-attribute
#
The user who created the scheduled event.
This will only be set for event created after 2021-10-25.
description
class-attribute
instance-attribute
#
Description of the scheduled event.
end_time
class-attribute
instance-attribute
#
When the event is scheduled to end, if set.
entity_type
class-attribute
instance-attribute
#
entity_type: ScheduledEventType = field(hash=False, repr=True)
The type of entity this scheduled event is associated with.
guild_id
class-attribute
instance-attribute
#
ID of the guild this scheduled event belongs to.
id
class-attribute
instance-attribute
#
ID of the scheduled event.
image_hash
class-attribute
instance-attribute
#
Hash of the image used for the scheduled event, if set.
name
class-attribute
instance-attribute
#
Name of the scheduled event.
privacy_level
class-attribute
instance-attribute
#
privacy_level: EventPrivacyLevel = field(hash=False, repr=False)
Privacy level of the scheduled event.
This restricts who can view and join the scheduled event.
start_time
class-attribute
instance-attribute
#
When the event is scheduled to start.
status
class-attribute
instance-attribute
#
status: ScheduledEventStatus = field(hash=False, repr=True)
Status of the scheduled event.
user_count
class-attribute
instance-attribute
#
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
#
Generate the cover image for this scheduled event, if set.
PARAMETER | DESCRIPTION |
---|---|
ext |
The extension to use for this URL.
supports
TYPE:
|
size |
The size to set for the URL.
Can be any power of two between
TYPE:
|
RETURNS | DESCRIPTION |
---|---|
Optional[URL]
|
The URL, or |
RAISES | DESCRIPTION |
---|---|
ValueError
|
If |