Package net.dv8tion.jda.api.events.user.update

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<EnumSet<User.UserFlag>>

net.dv8tion.jda.api.events.user.update.UserUpdateFlagsEvent

All Implemented Interfaces:

GenericEvent, UpdateEvent<User,EnumSet<User.UserFlag>>

public class UserUpdateFlagsEvent
extends GenericUserUpdateEvent<EnumSet<User.UserFlag>>

Indicates that the UserFlags of a User changed.

Can be used to retrieve the User who got their flags changed and their previous flags.

Identifier: public_flags

Requirements

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

Additionally, this event also 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 String	IDENTIFIER

Constructor Summary

Constructors

Constructor	Description
UserUpdateFlagsEvent(JDA api, long responseNumber, User user, EnumSet<User.UserFlag> oldFlags)

Method Summary

Modifier and Type	Method	Description
EnumSet<User.UserFlag>	getNewFlags()	Gets the new UserFlags of the User as EnumSet.
int	getNewFlagsRaw()	Gets the new UserFlags of the user and returns it as bitmask representation.
EnumSet<User.UserFlag>	getOldFlags()	Gets the old UserFlags of the User as EnumSet.
int	getOldFlagsRaw()	Gets the old UserFlags of 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 String IDENTIFIER

See Also:

Constant Field Values

Constructor Detail

UserUpdateFlagsEvent

public UserUpdateFlagsEvent(@Nonnull
                            JDA api,
                            long responseNumber,
                            @Nonnull
                            User user,
                            @Nonnull
                            EnumSet<User.UserFlag> oldFlags)

Method Detail

getOldFlags

@Nonnull
public EnumSet<User.UserFlag> getOldFlags()

Gets the old UserFlags of the User as EnumSet.

Returns:

EnumSet of the old UserFlags

getOldFlagsRaw

public int getOldFlagsRaw()

Gets the old UserFlags of the user and returns it as bitmask representation.

Returns:

The old bitmask representation of the UserFlags.

getNewFlags

@Nonnull
public EnumSet<User.UserFlag> getNewFlags()

Gets the new UserFlags of the User as EnumSet.

Returns:

The new EnumSet<{@link net.dv8tion.jda.api.entities.User.UserFlag UserFlag}> representation of the User's flags.

getNewFlagsRaw

public int getNewFlagsRaw()

Gets the new UserFlags of the user and returns it as bitmask representation.

Returns:

The new bitmask representation of the UserFlags.