Package net.dv8tion.jda.api.events.guild.member.update

Class GuildMemberUpdateNicknameEvent

java.lang.Object

net.dv8tion.jda.api.events.Event

net.dv8tion.jda.api.events.guild.GenericGuildEvent

net.dv8tion.jda.api.events.guild.member.GenericGuildMemberEvent

net.dv8tion.jda.api.events.guild.member.update.GenericGuildMemberUpdateEvent<java.lang.String>

net.dv8tion.jda.api.events.guild.member.update.GuildMemberUpdateNicknameEvent

All Implemented Interfaces:

GenericEvent, UpdateEvent<Member,java.lang.String>

public class GuildMemberUpdateNicknameEvent
extends GenericGuildMemberUpdateEvent<java.lang.String>

Indicates that a Member updated their Guild nickname.

Can be used to retrieve members who change their nickname, triggering guild, the old nick and the new nick.

Identifier: nick

Requirements

This event requires the GUILD_MEMBERS intent to be enabled.
createDefault(String) and createLight(String) disable this by default!

Additionally, this event requires the MemberCachePolicy to cache the updated members. Discord does not specifically tell us about the updates, but merely tells us the member was updated and gives us the updated member object. In order to fire a specific event like this we need to have the old member cached to compare against.

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	IDENTIFIER

Constructor Summary

Constructors

Constructor	Description
GuildMemberUpdateNicknameEvent(JDA api, long responseNumber, Member member, java.lang.String oldNick)

Method Summary

Modifier and Type	Method	Description
java.lang.String	getNewNickname()	The new nickname
java.lang.String	getOldNickname()	The old nickname

Methods inherited from class net.dv8tion.jda.api.events.guild.member.update.GenericGuildMemberUpdateEvent

getEntity, getNewValue, getOldValue, getPropertyIdentifier, toString

Methods inherited from class net.dv8tion.jda.api.events.guild.member.GenericGuildMemberEvent

getMember, getUser

Methods inherited from class net.dv8tion.jda.api.events.guild.GenericGuildEvent

getGuild

Methods inherited from class net.dv8tion.jda.api.events.Event

getJDA, getResponseNumber

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface net.dv8tion.jda.api.events.GenericEvent

getJDA, getResponseNumber

Methods inherited from interface net.dv8tion.jda.api.events.UpdateEvent

getEntityType

Field Detail

IDENTIFIER

public static final java.lang.String IDENTIFIER

See Also:

Constant Field Values

Constructor Detail

GuildMemberUpdateNicknameEvent

public GuildMemberUpdateNicknameEvent(@Nonnull
                                      JDA api,
                                      long responseNumber,
                                      @Nonnull
                                      Member member,
                                      @Nullable
                                      java.lang.String oldNick)

Method Detail

getOldNickname

@Nullable
public java.lang.String getOldNickname()

The old nickname

Returns:

The old nickname

getNewNickname

@Nullable
public java.lang.String getNewNickname()

The new nickname

Returns:

The new nickname