Package discord4j.core.event.domain.guild

Class BanEvent

java.lang.Object

discord4j.core.event.domain.Event

discord4j.core.event.domain.guild.GuildEvent

discord4j.core.event.domain.guild.BanEvent

public class BanEvent
extends GuildEvent

Dispatched when a user is banned from a guild.

This event is dispatched by Discord.

See Also:

• Guild Ban Add

Constructor Summary

Constructors

Constructor	Description
BanEvent(GatewayDiscordClient gateway, ShardInfo shardInfo, User user, long guildId)

Method Summary

Modifier and Type	Method	Description
Mono<Guild>	getGuild()	Requests to retrieve the Guild the User was banned from.
Snowflake	getGuildId()	Gets the Snowflake ID of the Guild in this event.
User	getUser()	Gets the User that has been banned from the Guild.
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

BanEvent

public BanEvent(GatewayDiscordClient gateway,
 ShardInfo shardInfo,
 User user,
 long guildId)

Method Details

getUser

public User getUser()

Gets the User that has been banned from the Guild.

Returns:

The User that has been banned.

getGuildId

public Snowflake getGuildId()

Gets the Snowflake ID of the Guild in this event.

Returns:

The ID of the Guild.

getGuild

public Mono<Guild> getGuild()

Requests to retrieve the Guild the User was banned from.

Returns:

A Mono where, upon successful completion, emits the Guild involved in this event. If an error is received, it is emitted through the Mono.

toString

public String toString()

Overrides:

toString in class Object