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

Class UserUpdateOnlineStatusEvent

java.lang.Object

net.dv8tion.jda.api.events.Event

net.dv8tion.jda.api.events.user.GenericUserEvent

net.dv8tion.jda.api.events.user.update.GenericUserUpdateEvent<OnlineStatus>

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

All Implemented Interfaces:

GenericEvent, UpdateEvent<User,OnlineStatus>, GenericUserPresenceEvent

public class UserUpdateOnlineStatusEvent
extends GenericUserUpdateEvent<OnlineStatus>
implements GenericUserPresenceEvent

Indicates that the OnlineStatus of a User changed.
As with any presence updates this happened for a Member in a Guild!

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

Identifier: status

Requirements

This event requires the GUILD_PRESENCES 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
UserUpdateOnlineStatusEvent(JDA api, long responseNumber, Member member, OnlineStatus oldOnlineStatus)

Method Summary

Modifier and Type	Method	Description
Guild	getGuild()	Guild in which the presence has changed.
Member	getMember()	Member who changed their presence.
OnlineStatus	getNewOnlineStatus()	The new status
OnlineStatus	getNewValue()	The new value
OnlineStatus	getOldOnlineStatus()	The old status
OnlineStatus	getOldValue()	The old value

Methods inherited from class net.dv8tion.jda.api.events.user.update.GenericUserUpdateEvent

getEntity, 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

UserUpdateOnlineStatusEvent

public UserUpdateOnlineStatusEvent(@Nonnull
                                   JDA api,
                                   long responseNumber,
                                   @Nonnull
                                   Member member,
                                   @Nonnull
                                   OnlineStatus oldOnlineStatus)

Method Detail

getGuild

@Nonnull
public Guild getGuild()

Description copied from interface: GenericUserPresenceEvent

Guild in which the presence has changed.

Specified by:

getGuild in interface GenericUserPresenceEvent

Returns:

The guild

getMember

@Nonnull
public Member getMember()

Description copied from interface: GenericUserPresenceEvent

Member who changed their presence.

Specified by:

getMember in interface GenericUserPresenceEvent

Returns:

The member

getOldOnlineStatus

@Nonnull
public OnlineStatus getOldOnlineStatus()

The old status

Returns:

The old status

getNewOnlineStatus

@Nonnull
public OnlineStatus getNewOnlineStatus()

The new status

Returns:

The new status

getOldValue

@Nonnull
public OnlineStatus getOldValue()

Description copied from interface: UpdateEvent

The old value

Specified by:

getOldValue in interface UpdateEvent<User,OnlineStatus>

Overrides:

getOldValue in class GenericUserUpdateEvent<OnlineStatus>

Returns:

The old value

getNewValue

@Nonnull
public OnlineStatus getNewValue()

Description copied from interface: UpdateEvent

The new value

Specified by:

getNewValue in interface UpdateEvent<User,OnlineStatus>

Overrides:

getNewValue in class GenericUserUpdateEvent<OnlineStatus>

Returns:

The new value