Skip to content

hikari.events.role_events#

Events pertaining to manipulation of roles within guilds.

RoleCreateEvent #

Bases: RoleEvent

Event fired when a role is created.

app property #

app: RESTAware

App instance for this application.

guild_id property #

guild_id: Snowflake

ID of the guild that this event relates to.

role class-attribute instance-attribute #

role: Role = attrs.field()

Role that was created.

role_id property #

role_id: Snowflake

ID of the role that this event relates to.

shard class-attribute instance-attribute #

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

Shard that received this event.

RoleDeleteEvent #

Bases: RoleEvent

Event fired when a role is deleted.

app class-attribute instance-attribute #

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

App instance for this application.

guild_id class-attribute instance-attribute #

guild_id: Snowflake = attrs.field()

ID of the guild that this event relates to.

old_role class-attribute instance-attribute #

old_role: Role | None = attrs.field()

The old role object.

This will be None if the role was missing from the cache.

role_id class-attribute instance-attribute #

role_id: Snowflake = attrs.field()

ID of the role that this event relates to.

shard class-attribute instance-attribute #

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

Shard that received this event.

RoleEvent #

Bases: ShardEvent, ABC

Event base for any event that involves guild roles.

guild_id abstractmethod property #

guild_id: Snowflake

ID of the guild that this event relates to.

role_id abstractmethod property #

role_id: Snowflake

ID of the role that this event relates to.

RoleUpdateEvent #

Bases: RoleEvent

Event fired when a role is updated.

app property #

app: RESTAware

App instance for this application.

guild_id property #

guild_id: Snowflake

ID of the guild that this event relates to.

old_role class-attribute instance-attribute #

old_role: Role | None = attrs.field()

The old role object.

This will be None if the role missing from the cache.

role class-attribute instance-attribute #

role: Role = attrs.field()

Role that was updated.

role_id property #

role_id: Snowflake

ID of the role that this event relates to.

shard class-attribute instance-attribute #

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

Shard that received this event.