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

Class GenericGuildMemberUpdateEvent<T>

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<T>

All Implemented Interfaces:

GenericEvent, UpdateEvent<Member,T>

Direct Known Subclasses:

GuildMemberUpdateAvatarEvent, GuildMemberUpdateBoostTimeEvent, GuildMemberUpdateNicknameEvent, GuildMemberUpdatePendingEvent

public abstract class GenericGuildMemberUpdateEvent<T>
extends GenericGuildMemberEvent
implements UpdateEvent<Member,T>

Indicates that a Guild member event is fired.
Every GuildMemberUpdateEvent is an instance of this event and can be casted.

Can be used to detect any GuildMemberUpdateEvent.

Requirements

These events require the GUILD_MEMBERS intent to be enabled.
createDefault(String) and createLight(String) disable this by default!

Additionally, these events require 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.

Constructor Summary

Constructors

Constructor	Description
GenericGuildMemberUpdateEvent(JDA api, long responseNumber, Member member, T previous, T next, java.lang.String identifier)

Method Summary

Modifier and Type	Method	Description
Member	getEntity()	The affected entity
T	getNewValue()	The new value
T	getOldValue()	The old value
java.lang.String	getPropertyIdentifier()	The field name for the updated property
java.lang.String	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

Constructor Detail

GenericGuildMemberUpdateEvent

public GenericGuildMemberUpdateEvent(@Nonnull
                                     JDA api,
                                     long responseNumber,
                                     @Nonnull
                                     Member member,
                                     @Nullable
                                     T previous,
                                     @Nullable
                                     T next,
                                     @Nonnull
                                     java.lang.String identifier)

Method Detail

getPropertyIdentifier

@Nonnull
public java.lang.String getPropertyIdentifier()

Description copied from interface: UpdateEvent

The field name for the updated property

Example

 @Override
 public void onGenericRoleUpdate(GenericRoleUpdateEvent event)
 {
     switch (event.getPropertyIdentifier())
     {
     case RoleUpdateColorEvent.IDENTIFIER:
         System.out.printf("Updated color for role: %s%n", event);
         break;
     case RoleUpdatePositionEvent.IDENTIFIER:
         RoleUpdatePositionEvent update = (RoleUpdatePositionEvent) event;
         System.out.printf("Updated position for role: %s raw(%s->%s)%n", event, update.getOldPositionRaw(), update.getNewPositionRaw());
         break;
     default: return;
     }
 }
 

Specified by:

getPropertyIdentifier in interface UpdateEvent<Member,T>

Returns:

The name of the updated property

getEntity

@Nonnull
public Member getEntity()

Description copied from interface: UpdateEvent

The affected entity

Specified by:

getEntity in interface UpdateEvent<Member,T>

Returns:

The affected entity

getOldValue

@Nullable
public T getOldValue()

Description copied from interface: UpdateEvent

The old value

Specified by:

getOldValue in interface UpdateEvent<Member,T>

Returns:

The old value

getNewValue

@Nullable
public T getNewValue()

Description copied from interface: UpdateEvent

The new value

Specified by:

getNewValue in interface UpdateEvent<Member,T>

Returns:

The new value

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object