Skip to content

hikari.events.scheduled_events#

Events fired for guild scheduled event related changes.

ScheduledEventCreateEvent #

Bases: ScheduledEventEvent

Event fired when a guild scheduled event is created.

app property #

app: RESTAware

App instance for this application.

event class-attribute instance-attribute #

event: ScheduledEvent = attrs.field()

The scheduled event that was created.

event_id property #

event_id: Snowflake

ID of the scheduled event.

shard class-attribute instance-attribute #

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

Shard that received this event.

ScheduledEventDeleteEvent #

Bases: ScheduledEventEvent

Event fired when a guild scheduled event is deleted.

app property #

app: RESTAware

App instance for this application.

event class-attribute instance-attribute #

event: ScheduledEvent = attrs.field()

The scheduled event that was deleted.

event_id property #

event_id: Snowflake

ID of the scheduled event.

shard class-attribute instance-attribute #

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

Shard that received this event.

ScheduledEventEvent #

Bases: ShardEvent, ABC

Event base for any scheduled event related events.

event_id abstractmethod property #

event_id: Snowflake

ID of the scheduled event.

ScheduledEventUpdateEvent #

Bases: ScheduledEventEvent

Event fired when a guild scheduled event is updated.

app property #

app: RESTAware

App instance for this application.

event class-attribute instance-attribute #

event: ScheduledEvent = attrs.field()

The scheduled event that was updated.

event_id property #

event_id: Snowflake

ID of the scheduled event.

shard class-attribute instance-attribute #

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

Shard that received this event.

ScheduledEventUserAddEvent #

Bases: ScheduledEventEvent

Event fired when a user subscribes to a guild scheduled event.

app class-attribute instance-attribute #

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

App instance for this application.

event_id class-attribute instance-attribute #

event_id: Snowflake = attrs.field()

ID of the scheduled event that the user was added to.

guild_id class-attribute instance-attribute #

guild_id: Snowflake = attrs.field()

ID of the guild that the scheduled event belongs to.

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 was added to the scheduled event.

ScheduledEventUserRemoveEvent #

Bases: ScheduledEventEvent

Event fired when a user unsubscribes from a guild scheduled event.

app class-attribute instance-attribute #

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

App instance for this application.

event_id class-attribute instance-attribute #

event_id: Snowflake = attrs.field()

ID of the scheduled event that the user was removed from.

guild_id class-attribute instance-attribute #

guild_id: Snowflake = attrs.field()

ID of the guild that the scheduled event belongs to.

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 was removed from the scheduled event.