Package discord4j.core.event.domain.guild

Class MemberLeaveEvent

java.lang.Object

discord4j.core.event.domain.Event

discord4j.core.event.domain.guild.GuildEvent

discord4j.core.event.domain.guild.MemberLeaveEvent

public class MemberLeaveEvent
extends GuildEvent

Dispatched when a user leaves a guild OR is kicked from it.

Discord does not differentiate between a user leaving on their own and being kicked. Except through audit logs, it is not possible to tell the difference between these.

This event is dispatched by Discord.

See Also:

• Guild Member Remove

Constructor Summary

Constructors

Constructor	Description
MemberLeaveEvent(GatewayDiscordClient gateway, ShardInfo shardInfo, User user, long guildId, Member member)

Method Summary

Modifier and Type	Method	Description
Mono<Guild>	getGuild()	Requests to retrieve the Guild that the User has left in this event.
Snowflake	getGuildId()	Gets the Snowflake ID of the Guild that the User has left in this event.
Optional<Member>	getMember()	Gets the Member object of the User that has left the Guild in this event, if present.
User	getUser()	Gets the User that has left the Guild in this event.
String	toString()

Methods inherited from class discord4j.core.event.domain.Event

getClient, getShardInfo

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Details

MemberLeaveEvent

public MemberLeaveEvent(GatewayDiscordClient gateway,
 ShardInfo shardInfo,
 User user,
 long guildId,
 @Nullable
 Member member)

Method Details

getUser

public User getUser()

Gets the User that has left the Guild in this event.

Returns:

The User that has left the Guild

getGuildId

public Snowflake getGuildId()

Gets the Snowflake ID of the Guild that the User has left in this event.

Returns:

The ID of the Guild.

getGuild

public Mono<Guild> getGuild()

Requests to retrieve the Guild that the User has left in this event.

Returns:

A Mono where, upon successful completion, emits the Guild that the User has left. If an error is received, it is emitted through the Mono.

getMember

public Optional<Member> getMember()

Gets the Member object of the User that has left the Guild in this event, if present.

Returns:

The Member object of the User that has left the Guild, if present.

toString

public String toString()

Overrides:

toString in class Object