hikari.events.member_events#

Events concerning manipulation of members within guilds.

Module Contents#

class hikari.events.member_events.MemberCreateEvent[source]#

Bases: MemberEvent

Event that is fired when a member joins a guild.

property guild_id: hikari.snowflakes.Snowflake[source]#

ID of the guild that this event relates to.

property user: hikari.users.User[source]#

User object for the member this event concerns.

member: hikari.guilds.Member[source]#

Member object for the member that joined the guild.

class hikari.events.member_events.MemberDeleteEvent[source]#

Bases: MemberEvent

Event fired when a member is kicked from or leaves a guild.

old_member: hikari.guilds.Member | None[source]#

The old member object.

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

class hikari.events.member_events.MemberEvent[source]#

Bases: hikari.events.shard_events.ShardEvent, abc.ABC

Event base for any events that concern guild members.

abstract property guild_id: hikari.snowflakes.Snowflake[source]#

ID of the guild that this event relates to.

abstract property user: hikari.users.User[source]#

User object for the member this event concerns.

property user_id: hikari.snowflakes.Snowflake[source]#

ID of the user that this event concerns.

get_guild()[source]#

Get the cached view of the guild this member event occurred in.

If the guild itself is not cached, this will return None.

Returns:
typing.Optional[hikari.guilds.GatewayGuild]

The guild that this event occurred in, if known, else None.

class hikari.events.member_events.MemberUpdateEvent[source]#

Bases: MemberEvent

Event that is fired when a member is updated in a guild.

This may occur if roles are amended, or if the nickname is changed.

property guild_id: hikari.snowflakes.Snowflake[source]#

ID of the guild that this event relates to.

property user: hikari.users.User[source]#

User object for the member this event concerns.

member: hikari.guilds.Member[source]#

Member object for the member that was updated.

old_member: hikari.guilds.Member | None[source]#

The old member object.

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