hikari.events.member_events
#
Events concerning manipulation of members within guilds.
MemberCreateEvent
#
Bases: MemberEvent
Event that is fired when a member joins a guild.
member
class-attribute
instance-attribute
#
Member object for the member that joined the guild.
shard
class-attribute
instance-attribute
#
shard: GatewayShard = field(metadata={SKIP_DEEP_COPY: True})
Shard that received this event.
dispatches
classmethod
#
Sequence of the event classes this event is dispatched as.
get_guild
#
get_guild() -> Optional[GatewayGuild]
Get the cached view of the guild this member event occurred in.
If the guild itself is not cached, this will return None
.
RETURNS | DESCRIPTION |
---|---|
Optional[GatewayGuild]
|
The guild that this event occurred in, if known, else
|
MemberDeleteEvent
#
Bases: MemberEvent
Event fired when a member is kicked from or leaves a guild.
guild_id
class-attribute
instance-attribute
#
ID of the guild that this event relates to.
old_member
class-attribute
instance-attribute
#
The old member object.
This will be None
if the member was missing from the cache.
shard
class-attribute
instance-attribute
#
shard: GatewayShard = field(metadata={SKIP_DEEP_COPY: True})
Shard that received this event.
user
class-attribute
instance-attribute
#
User object for the member this event concerns.
dispatches
classmethod
#
Sequence of the event classes this event is dispatched as.
get_guild
#
get_guild() -> Optional[GatewayGuild]
Get the cached view of the guild this member event occurred in.
If the guild itself is not cached, this will return None
.
RETURNS | DESCRIPTION |
---|---|
Optional[GatewayGuild]
|
The guild that this event occurred in, if known, else
|
MemberEvent
#
Bases: ShardEvent
, ABC
Event base for any events that concern guild members.
dispatches
classmethod
#
Sequence of the event classes this event is dispatched as.
get_guild
#
get_guild() -> Optional[GatewayGuild]
Get the cached view of the guild this member event occurred in.
If the guild itself is not cached, this will return None
.
RETURNS | DESCRIPTION |
---|---|
Optional[GatewayGuild]
|
The guild that this event occurred in, if known, else
|
MemberUpdateEvent
#
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.
member
class-attribute
instance-attribute
#
Member object for the member that was updated.
old_member
class-attribute
instance-attribute
#
The old member object.
This will be None
if the member missing from the cache.
shard
class-attribute
instance-attribute
#
shard: GatewayShard = field(metadata={SKIP_DEEP_COPY: True})
Shard that received this event.
dispatches
classmethod
#
Sequence of the event classes this event is dispatched as.
get_guild
#
get_guild() -> Optional[GatewayGuild]
Get the cached view of the guild this member event occurred in.
If the guild itself is not cached, this will return None
.
RETURNS | DESCRIPTION |
---|---|
Optional[GatewayGuild]
|
The guild that this event occurred in, if known, else
|