Skip to content

~.event

PersistEvent

Bases: hikari.Event

Base event for all persistent cache-related events.

PersistObjectEvent dataclass 

PersistObjectEvent(*, successful: bool)

Bases: PersistEvent

Base event for all persistent cache-related events that can pass/fail a rule.

successful instance-attribute 

successful: bool

If the object's operation was successful. True is passed custom rules/filters, otherwise False. Will always be True for ~RemoveEvent.

BulkChannelEvent dataclass 

BulkChannelEvent(
    *,
    failed: set[hikari.GuildChannel],
    guild: hikari.Guild,
    passed: set[hikari.GuildChannel]
)

Bases: PersistEvent

Dispatched when an array of channels are attempted to be manipulated in the cache. Inserts, removals, and updates may occur on any one channel in this event depending on it's status in the cache and on Discord's end.

failed instance-attribute 

failed: set[hikari.GuildChannel]

All channels that failed to pass channel rules/filters.

guild instance-attribute 

guild: hikari.Guild

The guild that the channels belong to.

passed instance-attribute 

passed: set[hikari.GuildChannel]

All channels that succeeded in passing channel rules/filters.

BulkMemberEvent dataclass 

BulkMemberEvent(
    *,
    failed: set[hikari.Member],
    guild_id: hikari.Snowflake,
    passed: set[hikari.Member]
)

Bases: PersistEvent

Dispatched when an array of members are attempted to be manipulated in the cache. Inserts, removals, and updates may occur on any one member in this event depending on it's status in the cache and on Discord's end.

failed instance-attribute 

failed: set[hikari.Member]

All members that failed to pass member rules/filters.

guild_id instance-attribute 

guild_id: hikari.Snowflake

The ID of the guild that the members belong to.

passed instance-attribute 

passed: set[hikari.Member]

All members that succeeded in passing channel rules/filters.

BulkRoleEvent dataclass 

BulkRoleEvent(
    *,
    failed: set[hikari.Role],
    guild: hikari.Guild,
    passed: set[hikari.Role]
)

Bases: PersistEvent

Dispatched when an array of roles are attempted to be manipulated in the cache. Inserts, removals, and updates may occur on any one role in this event depending on it's status in the cache and on Discord's end.

failed instance-attribute 

failed: set[hikari.Role]

All roles that failed to pass role rules/filters.

guild instance-attribute 

guild: hikari.Guild

The guild that the roles belong to.

passed instance-attribute 

passed: set[hikari.Role]

All roles that succeeded in passing role rules/filters.

ChannelInsertEvent dataclass 

ChannelInsertEvent(
    *, successful: bool, channel: hikari.GuildChannel
)

Bases: PersistObjectEvent

Dispatched when a channel is attempted to be inserted into the cache.

channel instance-attribute 

channel: hikari.GuildChannel

The channel that was attempted to be inserted into the cache.

successful instance-attribute 

successful: bool

If the object's operation was successful. True is passed custom rules/filters, otherwise False. Will always be True for ~RemoveEvent.

ChannelRemoveEvent dataclass 

ChannelRemoveEvent(
    *,
    successful: bool = True,
    channel_id: hikari.Snowflake,
    guild_id: hikari.Snowflake
)

Bases: PersistObjectEvent

Dispatched when a channel is attempted to be removed from the cache.

channel_id instance-attribute 

channel_id: hikari.Snowflake

The ID of the channel that was attempted to be removed from the cache.

guild_id instance-attribute 

guild_id: hikari.Snowflake

The ID of the guild the channel belongs to.

successful class-attribute instance-attribute 

successful: bool = True

If the object's operation was successful. True is passed custom rules/filters, otherwise False. Will always be True for ~RemoveEvent.

ChannelUpdateEvent dataclass 

ChannelUpdateEvent(
    *, successful: bool, channel: hikari.GuildChannel
)

Bases: PersistObjectEvent

Dispatched when a channel is attempted to be updated in the cache.

channel instance-attribute 

channel: hikari.GuildChannel

The channel that was attempted to be updated in the cache.

successful instance-attribute 

successful: bool

If the object's operation was successful. True is passed custom rules/filters, otherwise False. Will always be True for ~RemoveEvent.

GuildInsertEvent dataclass 

GuildInsertEvent(*, successful: bool, guild: hikari.Guild)

Bases: PersistObjectEvent

Dispatched when a guild is attempted to be inserted into the cache.

guild instance-attribute 

guild: hikari.Guild

The guild that was attempted to be inserted into the cache.

successful instance-attribute 

successful: bool

If the object's operation was successful. True is passed custom rules/filters, otherwise False. Will always be True for ~RemoveEvent.

GuildRemoveEvent dataclass 

GuildRemoveEvent(
    *, successful: bool = True, guild_id: hikari.Snowflake
)

Bases: PersistObjectEvent

Dispatched when a guild is attempted to be removed from the cache.

guild_id instance-attribute 

guild_id: hikari.Snowflake

The ID of the guild that was attempted to be removed from the cache.

successful class-attribute instance-attribute 

successful: bool = True

If the object's operation was successful. True is passed custom rules/filters, otherwise False. Will always be True for ~RemoveEvent.

GuildUpdateEvent dataclass 

GuildUpdateEvent(*, successful: bool, guild: hikari.Guild)

Bases: PersistObjectEvent

Dispatched when a guild is attempted to be updated in the cache.

Also fired for the guild in the GUILD_AVAILABLE event.

guild instance-attribute 

guild: hikari.Guild

The guild that was attempted to be updated in the cache.

successful instance-attribute 

successful: bool

If the object's operation was successful. True is passed custom rules/filters, otherwise False. Will always be True for ~RemoveEvent.

MemberInsertEvent dataclass 

MemberInsertEvent(
    *, successful: bool, member: hikari.Member
)

Bases: PersistObjectEvent

Dispatched when a member is attempted to be inserted into the cache.

member instance-attribute 

member: hikari.Member

The member that was attempted to be inserted into the cache.

successful instance-attribute 

successful: bool

If the object's operation was successful. True is passed custom rules/filters, otherwise False. Will always be True for ~RemoveEvent.

MemberRemoveEvent dataclass 

MemberRemoveEvent(
    *,
    successful: bool = True,
    guild_id: hikari.Snowflake,
    user: hikari.User
)

Bases: PersistObjectEvent

Dispatched when a member is attempted to be removed from the cache.

guild_id instance-attribute 

guild_id: hikari.Snowflake

The ID of the guild the member was in.

user instance-attribute 

user: hikari.User

The user of the member that was attempted to be removed from the cache.

successful class-attribute instance-attribute 

successful: bool = True

If the object's operation was successful. True is passed custom rules/filters, otherwise False. Will always be True for ~RemoveEvent.

MemberUpdateEvent dataclass 

MemberUpdateEvent(
    *, successful: bool, member: hikari.Member
)

Bases: PersistObjectEvent

Dispatched when a member is attempted to be updated in the cache.

member instance-attribute 

member: hikari.Member

The member that was attempted to be updated in the cache.

successful instance-attribute 

successful: bool

If the object's operation was successful. True is passed custom rules/filters, otherwise False. Will always be True for ~RemoveEvent.

RoleInsertEvent dataclass 

RoleInsertEvent(*, successful: bool, role: hikari.Role)

Bases: PersistObjectEvent

Dispatched when a role is attempted to be inserted into the cache.

role instance-attribute 

role: hikari.Role

The role that was attempted to be inserted into the cache.

successful instance-attribute 

successful: bool

If the object's operation was successful. True is passed custom rules/filters, otherwise False. Will always be True for ~RemoveEvent.

RoleRemoveEvent dataclass 

RoleRemoveEvent(
    *,
    successful: bool = True,
    guild_id: hikari.Snowflake,
    role_id: hikari.Snowflake
)

Bases: PersistObjectEvent

Dispatched when a role is attempted to be removed from the cache.

guild_id instance-attribute 

guild_id: hikari.Snowflake

The ID of the guild the role was in.

role_id instance-attribute 

role_id: hikari.Snowflake

The ID of the role that was attempted to be removed from the cache.

successful class-attribute instance-attribute 

successful: bool = True

If the object's operation was successful. True is passed custom rules/filters, otherwise False. Will always be True for ~RemoveEvent.

RoleUpdateEvent dataclass 

RoleUpdateEvent(*, successful: bool, role: hikari.Role)

Bases: PersistObjectEvent

Dispatched when a role is attempted to be updated in the cache.

role instance-attribute 

role: hikari.Role

The role that was attempted to be updated in the cache.

successful instance-attribute 

successful: bool

If the object's operation was successful. True is passed custom rules/filters, otherwise False. Will always be True for ~RemoveEvent.