-
-
Notifications
You must be signed in to change notification settings - Fork 722
/
OnlineStatus.java
69 lines (64 loc) · 2.15 KB
/
OnlineStatus.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
/*
* Copyright 2015-2016 Austin Keener & Michael Ritter
*
* 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.core;
/**
* Represents the online presence of a {@link net.dv8tion.jda.core.entities.User User}.
*/
public enum OnlineStatus
{
ONLINE("online"),
IDLE("idle"),
DO_NOT_DISTURB("dnd"),
OFFLINE("offline"),
INVISIBLE("invisible"),
UNKNOWN("");
private final String key;
OnlineStatus(String key)
{
this.key = key;
}
/**
* The valid API key for this OnlineStatus
*
* @return
* String representation of the valid API key for this OnlineStatus
* @see <a href="https://discordapp.com/developers/docs/topics/gateway#presence-update">PRESENCE_UPDATE</a>
*/
public String getKey()
{
return key;
}
/**
* Will get the {@link net.dv8tion.jda.core.OnlineStatus OnlineStatus} from the provided key.<br>
* If the provided key does no match a presence, this will return {@link net.dv8tion.jda.core.OnlineStatus#UNKNOWN UNKONWN}
*
* @param key
* The key relating to the {@link net.dv8tion.jda.core.OnlineStatus OnlineStatus} we wish to retrieve.
* @return
* The matching {@link net.dv8tion.jda.core.OnlineStatus OnlineStatus}. If there is no match, returns {@link net.dv8tion.jda.core.OnlineStatus#UNKNOWN UNKONWN}.
*/
public static OnlineStatus fromKey(String key)
{
for (OnlineStatus onlineStatus : values())
{
if (onlineStatus.key.equalsIgnoreCase(key))
{
return onlineStatus;
}
}
return UNKNOWN;
}
}