-
-
Notifications
You must be signed in to change notification settings - Fork 739
/
UserUpdateAvatarEvent.java
95 lines (86 loc) · 3.07 KB
/
UserUpdateAvatarEvent.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
/*
* Copyright 2015-2020 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.entities.User;
import javax.annotation.Nonnull;
import javax.annotation.Nullable;
/**
* Indicates that the Avatar of a {@link net.dv8tion.jda.api.entities.User User} changed.
*
* <p>Can be used to retrieve the User who changed their avatar and their previous Avatar ID/URL.
*
* <p>Identifier: {@code avatar}
*
* <h2>Requirements</h2>
*
* <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 UserUpdateAvatarEvent extends GenericUserUpdateEvent<String>
{
public static final String IDENTIFIER = "avatar";
public UserUpdateAvatarEvent(@Nonnull JDA api, long responseNumber, @Nonnull User user, @Nullable String oldAvatar)
{
super(api, responseNumber, user, oldAvatar, user.getAvatarId(), IDENTIFIER);
}
/**
* The previous avatar id
*
* @return The previous avatar id
*/
@Nullable
public String getOldAvatarId()
{
return getOldValue();
}
/**
* The previous avatar url
*
* @return The previous avatar url
*/
@Nullable
public String getOldAvatarUrl()
{
return previous == null ? null : String.format(User.AVATAR_URL, getUser().getId(), previous, previous.startsWith("a_") ? "gif" : "png");
}
/**
* The new avatar id
*
* @return The new avatar id
*/
@Nullable
public String getNewAvatarId()
{
return getNewValue();
}
/**
* The url of the new avatar
*
* @return The url of the new avatar
*/
@Nullable
public String getNewAvatarUrl()
{
return next == null ? null : String.format(User.AVATAR_URL, getUser().getId(), next, next.startsWith("a_") ? "gif" : "png");
}
}