/
UserUpdateOnlineStatusEvent.java
111 lines (99 loc) · 3.37 KB
/
UserUpdateOnlineStatusEvent.java
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
/*
* Copyright 2015 Austin Keener, Michael Ritter, Florian Spieß, and the JDA contributors
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package net.dv8tion.jda.api.events.user.update;
import net.dv8tion.jda.api.JDA;
import net.dv8tion.jda.api.JDABuilder;
import net.dv8tion.jda.api.OnlineStatus;
import net.dv8tion.jda.api.entities.Guild;
import net.dv8tion.jda.api.entities.Member;
import net.dv8tion.jda.api.entities.User;
import net.dv8tion.jda.api.requests.GatewayIntent;
import net.dv8tion.jda.api.utils.MemberCachePolicy;
import net.dv8tion.jda.api.utils.cache.CacheFlag;
import javax.annotation.Nonnull;
/**
* Indicates that the {@link OnlineStatus} of a {@link User} changed.
* <br>As with any presence updates this happened for a {@link Member} in a Guild!
* <p>Can be used to retrieve the User who changed their status and their previous status.
*
* <p>Identifier: {@code status}
*
* <p><b>Requirements</b><br>
*
* <p>This event requires the {@link GatewayIntent#GUILD_PRESENCES GUILD_PRESENCES} intent and {@link CacheFlag#ONLINE_STATUS} to be enabled.
* <br>{@link JDABuilder#createDefault(String) createDefault(String)} and
* {@link JDABuilder#createLight(String) createLight(String)} disable this by default!
*
* <p>Additionally, this event requires the {@link 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.
*/
public class UserUpdateOnlineStatusEvent extends GenericUserUpdateEvent<OnlineStatus> implements GenericUserPresenceEvent
{
public static final String IDENTIFIER = "status";
private final Guild guild;
private final Member member;
public UserUpdateOnlineStatusEvent(@Nonnull JDA api, long responseNumber, @Nonnull Member member, @Nonnull OnlineStatus oldOnlineStatus)
{
super(api, responseNumber, member.getUser(), oldOnlineStatus, member.getOnlineStatus(), IDENTIFIER);
this.guild = member.getGuild();
this.member = member;
}
@Nonnull
@Override
public Guild getGuild()
{
return guild;
}
@Nonnull
@Override
public Member getMember()
{
return member;
}
/**
* The old status
*
* @return The old status
*/
@Nonnull
public OnlineStatus getOldOnlineStatus()
{
return getOldValue();
}
/**
* The new status
*
* @return The new status
*/
@Nonnull
public OnlineStatus getNewOnlineStatus()
{
return getNewValue();
}
@Nonnull
@Override
public OnlineStatus getOldValue()
{
return super.getOldValue();
}
@Nonnull
@Override
public OnlineStatus getNewValue() {
return super.getNewValue();
}
}