ScheduledEvent

Attributes

channel_id : int

The event's stage's channel identifier.

creator : ClientUserBase

The event's creator.

description : None, str

Description of the event.

end : None, datetime

The scheduled end time of the event.

entity_id : int

The event's entity's identifier.

entity_metadata : ScheduledEventEntityMetadataBase

Metadata about the target entity.

entity_type : ScheduledEventEntityType

To which type of entity the event is bound to.

guild_id : int

The respective event's identifier.

id : int

The scheduled event's identifier number.

image_hash : int

The event's image hash.

image_type : IconType

The event's image's type.

name : str

The event's name.

privacy_level : PrivacyLevel

The privacy level of the event.

sku_ids : None, tuple of int

Stock keeping unit identifiers used at the event.

start : None, datetime

The scheduled start time of the event.

status : ScheduledEventStatus

The status of the event.

user_count : int

Users subscribed to the event.

Notes

Scheduled event instances support weakreferencing.

Properties

channel

Returns the event's channel if has any.

Returns

channel : None, Channel

created_at

When the entity was created.

Returns

created_at : datetime

creator_id

The event's creator's identifier.

Returns

user_id : int

entity

Returns the stage channel's entity if applicable.

Returns

entity : None, Channel

guild

Returns the event's guild.

Returns

guild : None, Guild

image

Returns the respective icon.

Returns

icon : Icon

image_url

Returns the scheduled event's image's url. If the scheduled event has no image, then returns None.

This function is a property of ScheduledEvent-s.

Returns

url : None, str

partial

Returns whether the scheduled event is partial.

Returns

partial : bool

url

Returns the scheduled event's url.

This function is a property of ScheduledEvent-s.

Returns

url : str

Methods

new(...)

Creates a new partial scheduled event with the given fields.

Parameter	Type	Description
channel_id	`int`, `Channel`	The event's stage's channel or its identifier.
description	`None`, `str`	Description of the event.
end	`None`, `datetime`	The scheduled end time of the event.
entity_type	`ScheduledEventEntityType`, `int`	To which type of entity the event is bound to.
image	`None`, `Icon`, `str`, `bytes-like`	The schedule event's image.
name	`str`	The event's name.
privacy_level	`PrivacyLevel`, `int`	The privacy level of the event.
start	`None`, `datetime`	The scheduled start time of the event.
status	`ScheduledEventStatus`	The status of the event.
**keyword_parameters	Keyword parameters	Additional keyword parameters passed to the entity metadata.
location	`None`, `str`	The place where the event will take place.
speaker_ids	`None`, `iterable` of (`int`, `ClientUserBase`)	The speakers' identifier of the stage channel.

Raises

TypeError

Extra or unused parameters.
If a parameter's type is incorrect.

ValueError

If a parameter's value is incorrect.

copy()

Copies the scheduled event.

Returns

new : instance<type<self>>

copy_with(...)

Copies the scheduled event with the given fields.

Parameter	Type	Description
channel_id	`int`, `Channel`	The event's stage's channel or its identifier.
description	`None`, `str`	Description of the event.
end	`None`, `datetime`	The scheduled end time of the event.
entity_type	`ScheduledEventEntityType`, `int`	To which type of entity the event is bound to.
image	`None`, `Icon`, `str`, `bytes-like`	The schedule event's image.
name	`str`	The event's name.
privacy_level	`PrivacyLevel`, `int`	The privacy level of the event.
start	`None`, `datetime`	The scheduled start time of the event.
status	`ScheduledEventStatus`	The status of the event.
**keyword_parameters	Keyword parameters	Additional keyword parameters passed to the entity metadata.
location	`None`, `str`	The place where the event will take place.
speaker_ids	`None`, `iterable` of (`int`, `ClientUserBase`)	The speakers' identifier of the stage channel.

Returns

new : instance<type<self>>

Raises

TypeError

If a parameter's value is incorrect.
Extra or unused parameters.

ValueError

If a parameter's type is incorrect.

from_data(data, ...)

Creates a new scheduled event instance from the received data.

If the instance already exists, returns that instead.

Parameter	Type	Optional	Keyword only	Default	Description
data	`dict` of (`str`, `object`) items				Guild scheduled event data.
strong_cache	`bool`			`True`	Whether the instance should be put into its strong cache.

Returns

self : instance<cls>

from_data_is_created(data)

Creates a new scheduled event instance from the received data. If already exists, picks it up.

Also returns whether the instance was new (or partial) or already existed.

Parameter	Type	Description
data	`dict` of (`str`, `object`) items	Guild scheduled event data.

Returns

self : instance<cls> is_created : bool

image_url_as(...)

Returns the scheduled event's image's url. If the scheduled event has no image, then returns None.

This function is a method of ScheduledEvent-s.

Parameter	Type	Optional	Default	Description
ext	`None`, `str`		`None`	The extension of the image's url. Can be any of: `'jpg'`, `'jpeg'`, `'png'`, `'webp'`.
size	`None`, `int`		`None`	The preferred minimal size of the image's url.

Returns

url : None, str

Raises

ValueError

If ext, size was not passed as any of the expected values.

iter_sku_ids()

Iterates over the stock keeping unit identifiers used at the event.

This method is an iterable generator.

Yields

sku_id : int

precreate(scheduled_event_id, ...)

Precreates the scheduled event by creating a partial one with the given parameters. When the scheduled event is loaded the precreated one will be picked up. If an already existing scheduled event would be precreated, returns that instead and updates that only, if that is partial.

Parameter	Type	Description
scheduled_event_id	`int`	The scheduled event's identifier.
entity_type	`ScheduledEventEntityType`, `int`	To which type of entity the event is bound to.
**keyword_parameters	keyword parameters	Additional predefined attributes for the scheduled event.
channel_id	`int`, `Channel`	Alternative for `channel`.
channel_id	`int`, `Channel`	The event's stage's channel or its identifier.
creator	`ClientUserBase`	The event's creator.
description	`None`, `str`	Description of the event.
end	`None`, `datetime`	The scheduled end time of the event.
entity_id	`int`	The event's entity's identifier.
entity_type	`ScheduledEventEntityType`, `int`	To which type of entity the event is bound to.
guild	`int`, `Guild`	Alternative for `guild_id`.
guild_id	`int`, `Guild`	The scheduled event's guild or its identifier.
image	`None`, `Icon`, `str`	The schedule event's image.
location	`None`, `str`	The place where the event will take place.
name	`str`	The event's name.
privacy_level	`PrivacyLevel`, `int`	The privacy level of the event.
sku_ids	`None`, `iterable` of `int`	Stock keeping unit identifiers used at the event.
speaker_ids	`None`, `iterable` of (`int`, `ClientUserBase`)	The speakers' identifier of the stage channel.
start	`None`, `datetime`	The scheduled start time of the event.
status	`ScheduledEventStatus`	The status of the event.
user_count	`int`	Users subscribed to the event.

Returns

self : instance<cls>

Raises

TypeError

If a parameter's type is incorrect.

ValueError

If a parameter's value is incorrect.

to_data(...)

Converts the scheduled event to a json serializable object.

Parameter	Type	Optional	Keyword only	Default	Description
defaults	`bool`			`False`	Whether fields with their default value should be included as well.
include_internals	`bool`			`False`	Whether internal fields should be included as well.

Returns

data : dict of (str, object) items

_create_empty(scheduled_event_id)

Creates a scheduled event instance with its attributes set to their default values.

Parameter	Type	Description
scheduled_event_id	`int`	The stage's identifier.

Returns

self : instance<cls>

_create_from_data_and_delete(data)

Creates a new scheduled event instance from the received data.

If the instance already exists, returns that instead.

Parameter	Type	Description
data	`dict` of (`str`, `object`) items	Guild event data.

Returns

self : instance<cls>

The created or found scheduled event instance.

_delete()

Tries to delete the scheduled event from its guild.

Returns

deleted : bool

_difference_update_attributes(data)

Updates the attributes of the scheduled event and returns the changed ones within an attribute-name- old-value relation.

Parameter	Type	Description
data	`dict` of (`str`, `object`) items	Scheduled event data.

Returns

old_attributes : dict of (str, object) items

The updated attributes.

The returned dictionary might contain the following items:

Key	Value
channel_id	`int`
description	`None`, `str`
end	`None`, `datetime`
entity_id	`int`
entity_metadata	`ScheduledEventEntityMetadataBase`
entity_type	`ScheduledEventEntityType`
image	`Icon`
name	`str`
privacy_level	`PrivacyLevel`
sku_ids	`None`, `tuple` of `int`
start	`None`, `datetime`
status	`ScheduledEventStatus`

_get_hash_partial()

Returns the scheduled event's hash value. This function is called when the scheduled event is partial.

Returns

hash_value : int

_is_equal_same_type(other)

Returns whether self is equal to other. Other must be same type as self.

Parameter	Type	Description
other	`instance<type<self>>`	The other instance.

Returns

is_equal : bool

_set_attributes(data)

Sets the event's attributes form the received data.

Parameter	Type	Description
data	`dict` of (`str`, `object`) items	Scheduled event data.

_update_attributes(data)

Updates the attributes of the scheduled event.

Parameter	Type	Description
data	`dict` of (`str`, `object`) items	Scheduled event data.

_update_counts_only(data)

Updates the scheduled event's count attributes only.

Parameter	Type	Description
data	`dict` of (`str`, `object`) items	Scheduled event data.

eq()

Returns whether the two scheduled events are equal.

ge()

Whether this entity's id is greater or equal than the other's.

getattr()

Drops a rich attribute error.

gt()

Whether this entity's id is greater than the other's.

hash()

Returns the scheduled event's hash value.

le()

Whether this entity's id is less or equal than the other's.

lt()

Whether this entity's id is less than the other's.

ne()

Returns whether the two scheduled events are not equal.

repr()

Returns the guild event's representation.

ScheduledEvent

Attributes

Notes

Properties

channel

Returns

created_at

Returns

creator_id

Returns

entity

Returns

guild

Returns

image

Returns

image_url

Returns

partial

Returns

url

Returns

Methods

__new__(...)

Raises

copy()

Returns

copy_with(...)

Returns

Raises

from_data(data, ...)

Returns

from_data_is_created(data)

Returns

image_url_as(...)

Returns

Raises

iter_sku_ids()

Yields

precreate(scheduled_event_id, ...)

Returns

Raises

to_data(...)

Returns

_create_empty(scheduled_event_id)

Returns

_create_from_data_and_delete(data)

Returns

_delete()

Returns

_difference_update_attributes(data)

Returns

_get_hash_partial()

Returns

_is_equal_same_type(other)

Returns

_set_attributes(data)

_update_attributes(data)

_update_counts_only(data)

__eq__()

__ge__()

__getattr__()

__gt__()

__hash__()

__le__()

__lt__()

__ne__()

__repr__()

new(...)

eq()

ge()

getattr()

gt()

hash()

le()

lt()

ne()

repr()