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        CLIENT_AWAY(false),
038        CLIENT_AWAY_MESSAGE(false),
039        /**
040         * Property for the Overwolf badge and any myTeamSpeak badges.
041         * Can be changed only for the own client by using {@link TS3Api#updateClient(Map)}.
042         * <p>
043         * String format: {@code overwolf=n:badges=guid,guid,guid(,guid...)}<br>
044         * where {@code n} is 0 or 1 and {@code guid} is 128-bit badge GUIDs
045         * </p>
046         */
047        CLIENT_BADGES(true),
048        CLIENT_BASE64HASHCLIENTUID(false),
049        CLIENT_CHANNEL_GROUP_ID(false),
050        CLIENT_CHANNEL_GROUP_INHERITED_CHANNEL_ID(false),
051        CLIENT_COUNTRY(false),
052        CLIENT_CREATED(false),
053        CLIENT_DATABASE_ID(false),
054        CLIENT_DEFAULT_CHANNEL(false),
055        CLIENT_DEFAULT_TOKEN(false),
056        CLIENT_DESCRIPTION(true),
057        CLIENT_FLAG_AVATAR(false),
058        CLIENT_FLAG_TALKING(false),
059        CLIENT_ICON_ID(true),
060        CLIENT_IDLE_TIME(false),
061        CLIENT_INPUT_HARDWARE(false),
062        CLIENT_INPUT_MUTED(false),
063        CLIENT_IS_CHANNEL_COMMANDER(true),
064        CLIENT_IS_PRIORITY_SPEAKER(false),
065        CLIENT_IS_RECORDING(false),
066        CLIENT_IS_TALKER(true),
067        CLIENT_LASTCONNECTED(false),
068        CLIENT_LOGIN_NAME(false),
069        CLIENT_META_DATA(false),
070        CLIENT_MONTH_BYTES_DOWNLOADED(false),
071        CLIENT_MONTH_BYTES_UPLOADED(false),
072        CLIENT_NEEDED_SERVERQUERY_VIEW_POWER(false),
073        CLIENT_NICKNAME(true),
074        CLIENT_NICKNAME_PHONETIC(false),
075        CLIENT_OUTPUT_HARDWARE(false),
076        CLIENT_OUTPUT_MUTED(false),
077        CLIENT_OUTPUTONLY_MUTED(false),
078        CLIENT_PLATFORM(false),
079        CLIENT_SERVERGROUPS(false),
080        CLIENT_TALK_POWER(false),
081        CLIENT_TALK_REQUEST(false),
082        CLIENT_TALK_REQUEST_MSG(false),
083        CLIENT_TOTAL_BYTES_DOWNLOADED(false),
084        CLIENT_TOTAL_BYTES_UPLOADED(false),
085        CLIENT_TOTALCONNECTIONS(false),
086        CLIENT_TYPE(false),
087        CLIENT_UNIQUE_IDENTIFIER(false),
088        CLIENT_UNREAD_MESSAGES(false),
089        CLIENT_VERSION(false),
090        CONNECTION_BANDWIDTH_RECEIVED_LAST_MINUTE_TOTAL(false),
091        CONNECTION_BANDWIDTH_RECEIVED_LAST_SECOND_TOTAL(false),
092        CONNECTION_BANDWIDTH_SENT_LAST_MINUTE_TOTAL(false),
093        CONNECTION_BANDWIDTH_SENT_LAST_SECOND_TOTAL(false),
094        CONNECTION_BYTES_RECEIVED_TOTAL(false),
095        CONNECTION_BYTES_SENT_TOTAL(false),
096        CONNECTION_CLIENT_IP(false),
097        CONNECTION_CONNECTED_TIME(false),
098        CONNECTION_FILETRANSFER_BANDWIDTH_RECEIVED(false),
099        CONNECTION_FILETRANSFER_BANDWIDTH_SENT(false),
100        CONNECTION_PACKETS_RECEIVED_TOTAL(false),
101        CONNECTION_PACKETS_SENT_TOTAL(false);
102
103        private final boolean changeable;
104
105        ClientProperty(boolean changeable) {
106                this.changeable = changeable;
107        }
108
109        @Override
110        public String getName() {
111                return name().toLowerCase(Locale.ROOT);
112        }
113
114        @Override
115        public boolean isChangeable() {
116                return changeable;
117        }
118}