-
-
Notifications
You must be signed in to change notification settings - Fork 723
/
MessageType.java
132 lines (113 loc) · 3.48 KB
/
MessageType.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
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
/*
* 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.entities;
import javax.annotation.Nonnull;
/**
* Represents the different types of {@link net.dv8tion.jda.api.entities.Message Messages} that can be received from Discord.
* <br>A normal text based message is {@link #DEFAULT}.
*/
public enum MessageType
{
/**
* The normal text messages received when a user or bot sends a Message.
*/
DEFAULT(0),
/**
* Specialized messages used for Groups as a System-Message showing that a new User has been added to the Group.
*/
RECIPIENT_ADD(1),
/**
* Specialized messages used for Groups as a System-Message showing that a new User has been removed from the Group.
*/
RECIPIENT_REMOVE(2),
/**
* Specialized message used for Groups as a System-Message showing that a Call was started.
*/
CALL(3),
/**
* Specialized message used for Groups as a System-Message showing that the name of the Group was changed.
*/
CHANNEL_NAME_CHANGE(4),
/**
* Specialized message used for Groups as a System-Message showing that the icon of the Group was changed.
*/
CHANNEL_ICON_CHANGE(5),
/**
* Specialized message used in MessageChannels as a System-Message to announce new pins
*/
CHANNEL_PINNED_ADD(6),
/**
* Specialized message used to welcome new members in a Guild
*/
GUILD_MEMBER_JOIN(7),
/**
* Specialized message used to announce a new booster
*/
GUILD_MEMBER_BOOST(8),
/**
* Specialized message used to announce the server has reached tier 1
*/
GUILD_BOOST_TIER_1(9),
/**
* Specialized message used to announce the server has reached tier 2
*/
GUILD_BOOST_TIER_2(10),
/**
* Specialized message used to announce the server has reached tier 3
*/
GUILD_BOOST_TIER_3(11),
/**
* Specialized message used to announce when a crosspost webhook is added to a channel
*/
CHANNEL_FOLLOW_ADD(12),
/**
* Unknown MessageType.
*/
UNKNOWN(-1);
protected final int id;
MessageType(int id)
{
this.id = id;
}
/**
* The Discord id key used to reference the MessageType.
*
* @return the Discord id key.
*/
public int getId()
{
return id;
}
/**
* Used to retrieve a MessageType based on the Discord id key.
* <br>If the {@code id} provided is not a known id, {@link #UNKNOWN} is returned
*
* @param id
* The Discord key id of the requested MessageType.
*
* @return A MessageType with the same Discord id key as the one provided, or {@link #UNKNOWN}.
*/
@Nonnull
public static MessageType fromId(int id)
{
for (MessageType type : values())
{
if (type.id == id)
return type;
}
return UNKNOWN;
}
}