001package com.github.theholywaffle.teamspeak3.api;
002
003/*
004 * #%L
005 * TeamSpeak 3 Java API
006 * %%
007 * Copyright (C) 2014 Bert De Geyter
008 * %%
009 * Permission is hereby granted, free of charge, to any person obtaining a copy
010 * of this software and associated documentation files (the "Software"), to deal
011 * in the Software without restriction, including without limitation the rights
012 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
013 * copies of the Software, and to permit persons to whom the Software is
014 * furnished to do so, subject to the following conditions:
015 * 
016 * The above copyright notice and this permission notice shall be included in
017 * all copies or substantial portions of the Software.
018 * 
019 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
020 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
021 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
022 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
023 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
024 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
025 * THE SOFTWARE.
026 * #L%
027 */
028
029import com.github.theholywaffle.teamspeak3.TS3Api;
030
031import java.util.Locale;
032import java.util.Map;
033
034public enum ClientProperty implements Property {
035
036        CID(false),
037        CLID(false),
038        CLIENT_AWAY(false),
039        CLIENT_AWAY_MESSAGE(false),
040        /**
041         * Property for the Overwolf badge and any myTeamSpeak badges.
042         * Can be changed only for the own client by using {@link TS3Api#updateClient(Map)}.
043         * <p>
044         * String format: {@code overwolf=n:badges=guid,guid,guid(,guid...)}<br>
045         * where {@code n} is 0 or 1 and {@code guid} is 128-bit badge GUIDs
046         * </p>
047         */
048        CLIENT_BADGES(true),
049        CLIENT_BASE64HASHCLIENTUID(false) {
050                @Override
051                public String getName() {
052                        return "client_base64HashClientUID";
053                }
054        },
055        CLIENT_CHANNEL_GROUP_ID(false),
056        CLIENT_CHANNEL_GROUP_INHERITED_CHANNEL_ID(false),
057        CLIENT_COUNTRY(false),
058        CLIENT_CREATED(false),
059        CLIENT_DATABASE_ID(false),
060        CLIENT_DEFAULT_CHANNEL(false),
061        CLIENT_DEFAULT_TOKEN(false),
062        CLIENT_DESCRIPTION(true),
063        CLIENT_ESTIMATED_LOCATION(false),
064        CLIENT_FLAG_AVATAR(false),
065        CLIENT_FLAG_TALKING(false),
066        CLIENT_ICON_ID(true),
067        CLIENT_IDLE_TIME(false),
068        CLIENT_INPUT_HARDWARE(false),
069        CLIENT_INPUT_MUTED(false),
070        CLIENT_INTEGRATIONS(false),
071        CLIENT_IS_CHANNEL_COMMANDER(true),
072        CLIENT_IS_PRIORITY_SPEAKER(false),
073        CLIENT_IS_RECORDING(false),
074        CLIENT_IS_TALKER(true),
075        CLIENT_LASTCONNECTED(false),
076        CLIENT_LOGIN_NAME(false),
077        CLIENT_META_DATA(false),
078        CLIENT_MONTH_BYTES_DOWNLOADED(false),
079        CLIENT_MONTH_BYTES_UPLOADED(false),
080        CLIENT_MYTEAMSPEAK_AVATAR(false),
081        CLIENT_MYTEAMSPEAK_ID(false),
082        CLIENT_NEEDED_SERVERQUERY_VIEW_POWER(false),
083        CLIENT_NICKNAME(true),
084        CLIENT_NICKNAME_PHONETIC(false),
085        CLIENT_OUTPUT_HARDWARE(false),
086        CLIENT_OUTPUT_MUTED(false),
087        CLIENT_OUTPUTONLY_MUTED(false),
088        CLIENT_PLATFORM(false),
089        CLIENT_SECURITY_HASH(false),
090        CLIENT_SERVERGROUPS(false),
091        CLIENT_SIGNED_BADGES(false),
092        CLIENT_TALK_POWER(false),
093        CLIENT_TALK_REQUEST(false),
094        CLIENT_TALK_REQUEST_MSG(false),
095        CLIENT_TOTAL_BYTES_DOWNLOADED(false),
096        CLIENT_TOTAL_BYTES_UPLOADED(false),
097        CLIENT_TOTALCONNECTIONS(false),
098        CLIENT_TYPE(false),
099        CLIENT_UNIQUE_IDENTIFIER(false),
100        CLIENT_UNREAD_MESSAGES(false),
101        CLIENT_VERSION(false),
102        CLIENT_VERSION_SIGN(false),
103        CONNECTION_BANDWIDTH_RECEIVED_LAST_MINUTE_TOTAL(false),
104        CONNECTION_BANDWIDTH_RECEIVED_LAST_SECOND_TOTAL(false),
105        CONNECTION_BANDWIDTH_SENT_LAST_MINUTE_TOTAL(false),
106        CONNECTION_BANDWIDTH_SENT_LAST_SECOND_TOTAL(false),
107        CONNECTION_BYTES_RECEIVED_TOTAL(false),
108        CONNECTION_BYTES_SENT_TOTAL(false),
109        CONNECTION_CLIENT_IP(false),
110        CONNECTION_CONNECTED_TIME(false),
111        CONNECTION_FILETRANSFER_BANDWIDTH_RECEIVED(false),
112        CONNECTION_FILETRANSFER_BANDWIDTH_SENT(false),
113        CONNECTION_PACKETS_RECEIVED_TOTAL(false),
114        CONNECTION_PACKETS_SENT_TOTAL(false);
115
116        private final boolean changeable;
117
118        ClientProperty(boolean changeable) {
119                this.changeable = changeable;
120        }
121
122        @Override
123        public String getName() {
124                return name().toLowerCase(Locale.ROOT);
125        }
126
127        @Override
128        public boolean isChangeable() {
129                return changeable;
130        }
131}