/
GuildMemberUpdateTimeOutEvent.java
75 lines (68 loc) · 2.72 KB
/
GuildMemberUpdateTimeOutEvent.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
/*
* 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.guild.member.update;
import net.dv8tion.jda.api.JDA;
import net.dv8tion.jda.api.entities.Member;
import javax.annotation.Nonnull;
import javax.annotation.Nullable;
import java.time.OffsetDateTime;
/**
* Indicates that a {@link net.dv8tion.jda.api.entities.Member Member} had their time out changed.
* <br><b>This event does not fire for automatic time out expiration.</b>
*
* <p>Can be used to retrieve members who had their time out changed and the triggering guild.
*
* <p>Identifier: {@code timeout_time}
*
* <p><b>Requirements</b><br>
*
* <p>This event requires the {@link net.dv8tion.jda.api.requests.GatewayIntent#GUILD_MEMBERS GUILD_MEMBERS} intent to be enabled.
* <br>{@link net.dv8tion.jda.api.JDABuilder#createDefault(String) createDefault(String)} and
* {@link net.dv8tion.jda.api.JDABuilder#createLight(String) createLight(String)} disable this by default!
*
* <p>Additionally, this event requires the {@link net.dv8tion.jda.api.utils.MemberCachePolicy 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 GuildMemberUpdateTimeOutEvent extends GenericGuildMemberUpdateEvent<OffsetDateTime>
{
public static final String IDENTIFIER = "timeout_time";
public GuildMemberUpdateTimeOutEvent(@Nonnull JDA api, long responseNumber, @Nonnull Member member, @Nullable OffsetDateTime previous)
{
super(api, responseNumber, member, previous, member.getTimeOutEnd(), IDENTIFIER);
}
/**
* The old end of the time out
*
* @return The old end of the time out
*/
@Nullable
public OffsetDateTime getOldTimeOutEnd()
{
return getOldValue();
}
/**
* The new end of the time out
*
* @return The new end of the time out
*/
@Nullable
public OffsetDateTime getNewTimeOutEnd()
{
return getNewValue();
}
}