Class UserUpdateFlagsEvent
- java.lang.Object
-
- net.dv8tion.jda.api.events.Event
-
- net.dv8tion.jda.api.events.user.GenericUserEvent
-
- net.dv8tion.jda.api.events.user.update.GenericUserUpdateEvent<java.util.EnumSet<User.UserFlag>>
-
- net.dv8tion.jda.api.events.user.update.UserUpdateFlagsEvent
-
- All Implemented Interfaces:
GenericEvent,UpdateEvent<User,java.util.EnumSet<User.UserFlag>>
public class UserUpdateFlagsEvent extends GenericUserUpdateEvent<java.util.EnumSet<User.UserFlag>>
Indicates that theUserFlagsof aUserchanged.Can be used to retrieve the User who got their flags changed and their previous flags.
Identifier:
public_flagsRequirements
This event requires the
GUILD_MEMBERSintent to be enabled.createDefault(String)andcreateLight(String)disable this by default!Additionally, this event also requires the
MemberCachePolicyto 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.StringIDENTIFIER
-
Constructor Summary
Constructors Constructor Description UserUpdateFlagsEvent(JDA api, long responseNumber, User user, java.util.EnumSet<User.UserFlag> oldFlags)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description java.util.EnumSet<User.UserFlag>getNewFlags()Gets the newUserFlagsof the User asEnumSet.intgetNewFlagsRaw()Gets the newUserFlagsof the user and returns it as bitmask representation.java.util.EnumSet<User.UserFlag>getOldFlags()Gets the oldUserFlagsof the User asEnumSet.intgetOldFlagsRaw()Gets the oldUserFlagsof the user and returns it as bitmask representation.-
Methods inherited from class net.dv8tion.jda.api.events.user.update.GenericUserUpdateEvent
getEntity, getNewValue, getOldValue, getPropertyIdentifier, toString
-
Methods inherited from class net.dv8tion.jda.api.events.user.GenericUserEvent
getUser
-
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
-
UserUpdateFlagsEvent
public UserUpdateFlagsEvent(@Nonnull JDA api, long responseNumber, @Nonnull User user, @Nonnull java.util.EnumSet<User.UserFlag> oldFlags)
-
-
Method Detail
-
getOldFlags
@Nonnull public java.util.EnumSet<User.UserFlag> getOldFlags()
Gets the oldUserFlagsof the User asEnumSet.- Returns:
EnumSetof the oldUserFlags
-
getOldFlagsRaw
public int getOldFlagsRaw()
Gets the oldUserFlagsof the user and returns it as bitmask representation.- Returns:
- The old bitmask representation of the
UserFlags.
-
getNewFlags
@Nonnull public java.util.EnumSet<User.UserFlag> getNewFlags()
Gets the newUserFlagsof the User asEnumSet.- Returns:
- The new
EnumSet<{@link net.dv8tion.jda.api.entities.User.UserFlag UserFlag}>representation of the User's flags.
-
-