discord4j.core.event.domain.guild

Class UnbanEvent

java.lang.Object

discord4j.core.event.domain.Event

discord4j.core.event.domain.guild.GuildEvent

discord4j.core.event.domain.guild.UnbanEvent

public class UnbanEvent
extends GuildEvent

Dispatched when a user is unbanned from a guild.

This event is dispatched by Discord.

See Also:

Guild Ban Remove

Constructor Summary

Constructors

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

Method Summary

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

UnbanEvent

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

Method Detail

getUser

public User getUser()

Gets the User that has been unbanned in this event.

Returns:

The User that has been unbanned.

getGuildId

public Snowflake getGuildId()

Gets the Snowflake ID of the Guild the User was unbanned from.

Returns:

The ID of the Guild involved.

getGuild

public Mono<Guild> getGuild()

Requests to retrieve the Guild the Member was unbanned from.

Returns:

A Mono where, upon successful completion, emits the Guild the User was unbanned from. If an error is received, it is emitted through the Mono.

toString

public String toString()

Overrides:

toString in class Object