com.github.theholywaffle.teamspeak3.api

Enum ClientProperty

java.lang.Object

java.lang.Enum<ClientProperty>

com.github.theholywaffle.teamspeak3.api.ClientProperty

All Implemented Interfaces:

Property, Serializable, Comparable<ClientProperty>

public enum ClientProperty
extends Enum<ClientProperty>
implements Property

Enum Constant Summary

Enum Constants

Enum Constant and Description
CID
CLIENT_AWAY
CLIENT_AWAY_MESSAGE
CLIENT_BADGES Property for the Overwolf badge and any myTeamSpeak badges.
CLIENT_BASE64HASHCLIENTUID
CLIENT_CHANNEL_GROUP_ID
CLIENT_CHANNEL_GROUP_INHERITED_CHANNEL_ID
CLIENT_COUNTRY
CLIENT_CREATED
CLIENT_DATABASE_ID
CLIENT_DEFAULT_CHANNEL
CLIENT_DEFAULT_TOKEN
CLIENT_DESCRIPTION
CLIENT_FLAG_AVATAR
CLIENT_FLAG_TALKING
CLIENT_ICON_ID
CLIENT_IDLE_TIME
CLIENT_INPUT_HARDWARE
CLIENT_INPUT_MUTED
CLIENT_IS_CHANNEL_COMMANDER
CLIENT_IS_PRIORITY_SPEAKER
CLIENT_IS_RECORDING
CLIENT_IS_TALKER
CLIENT_LASTCONNECTED
CLIENT_LOGIN_NAME
CLIENT_META_DATA
CLIENT_MONTH_BYTES_DOWNLOADED
CLIENT_MONTH_BYTES_UPLOADED
CLIENT_NEEDED_SERVERQUERY_VIEW_POWER
CLIENT_NICKNAME
CLIENT_NICKNAME_PHONETIC
CLIENT_OUTPUT_HARDWARE
CLIENT_OUTPUT_MUTED
CLIENT_OUTPUTONLY_MUTED
CLIENT_PLATFORM
CLIENT_SERVERGROUPS
CLIENT_TALK_POWER
CLIENT_TALK_REQUEST
CLIENT_TALK_REQUEST_MSG
CLIENT_TOTAL_BYTES_DOWNLOADED
CLIENT_TOTAL_BYTES_UPLOADED
CLIENT_TOTALCONNECTIONS
CLIENT_TYPE
CLIENT_UNIQUE_IDENTIFIER
CLIENT_UNREAD_MESSAGES
CLIENT_VERSION
CONNECTION_BANDWIDTH_RECEIVED_LAST_MINUTE_TOTAL
CONNECTION_BANDWIDTH_RECEIVED_LAST_SECOND_TOTAL
CONNECTION_BANDWIDTH_SENT_LAST_MINUTE_TOTAL
CONNECTION_BANDWIDTH_SENT_LAST_SECOND_TOTAL
CONNECTION_BYTES_RECEIVED_TOTAL
CONNECTION_BYTES_SENT_TOTAL
CONNECTION_CLIENT_IP
CONNECTION_CONNECTED_TIME
CONNECTION_FILETRANSFER_BANDWIDTH_RECEIVED
CONNECTION_FILETRANSFER_BANDWIDTH_SENT
CONNECTION_PACKETS_RECEIVED_TOTAL
CONNECTION_PACKETS_SENT_TOTAL

Method Summary

Modifier and Type	Method and Description
String	getName()
boolean	isChangeable()
static ClientProperty	valueOf(String name) Returns the enum constant of this type with the specified name.
static ClientProperty[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

CID

public static final ClientProperty CID

CLIENT_AWAY

public static final ClientProperty CLIENT_AWAY

CLIENT_AWAY_MESSAGE

public static final ClientProperty CLIENT_AWAY_MESSAGE

CLIENT_BADGES

public static final ClientProperty CLIENT_BADGES

Property for the Overwolf badge and any myTeamSpeak badges. Can be changed only for the own client by using TS3Api.updateClient(Map).

String format: overwolf=n:badges=guid,guid,guid(,guid...)
where n is 0 or 1 and guid is 128-bit badge GUIDs

CLIENT_BASE64HASHCLIENTUID

public static final ClientProperty CLIENT_BASE64HASHCLIENTUID

CLIENT_CHANNEL_GROUP_ID

public static final ClientProperty CLIENT_CHANNEL_GROUP_ID

CLIENT_CHANNEL_GROUP_INHERITED_CHANNEL_ID

public static final ClientProperty CLIENT_CHANNEL_GROUP_INHERITED_CHANNEL_ID

CLIENT_COUNTRY

public static final ClientProperty CLIENT_COUNTRY

CLIENT_CREATED

public static final ClientProperty CLIENT_CREATED

CLIENT_DATABASE_ID

public static final ClientProperty CLIENT_DATABASE_ID

CLIENT_DEFAULT_CHANNEL

public static final ClientProperty CLIENT_DEFAULT_CHANNEL

CLIENT_DEFAULT_TOKEN

public static final ClientProperty CLIENT_DEFAULT_TOKEN

CLIENT_DESCRIPTION

public static final ClientProperty CLIENT_DESCRIPTION

CLIENT_FLAG_AVATAR

public static final ClientProperty CLIENT_FLAG_AVATAR

CLIENT_FLAG_TALKING

public static final ClientProperty CLIENT_FLAG_TALKING

CLIENT_ICON_ID

public static final ClientProperty CLIENT_ICON_ID

CLIENT_IDLE_TIME

public static final ClientProperty CLIENT_IDLE_TIME

CLIENT_INPUT_HARDWARE

public static final ClientProperty CLIENT_INPUT_HARDWARE

CLIENT_INPUT_MUTED

public static final ClientProperty CLIENT_INPUT_MUTED

CLIENT_IS_CHANNEL_COMMANDER

public static final ClientProperty CLIENT_IS_CHANNEL_COMMANDER

CLIENT_IS_PRIORITY_SPEAKER

public static final ClientProperty CLIENT_IS_PRIORITY_SPEAKER

CLIENT_IS_RECORDING

public static final ClientProperty CLIENT_IS_RECORDING

CLIENT_IS_TALKER

public static final ClientProperty CLIENT_IS_TALKER

CLIENT_LASTCONNECTED

public static final ClientProperty CLIENT_LASTCONNECTED

CLIENT_LOGIN_NAME

public static final ClientProperty CLIENT_LOGIN_NAME

CLIENT_META_DATA

public static final ClientProperty CLIENT_META_DATA

CLIENT_MONTH_BYTES_DOWNLOADED

public static final ClientProperty CLIENT_MONTH_BYTES_DOWNLOADED

CLIENT_MONTH_BYTES_UPLOADED

public static final ClientProperty CLIENT_MONTH_BYTES_UPLOADED

CLIENT_NEEDED_SERVERQUERY_VIEW_POWER

public static final ClientProperty CLIENT_NEEDED_SERVERQUERY_VIEW_POWER

CLIENT_NICKNAME

public static final ClientProperty CLIENT_NICKNAME

CLIENT_NICKNAME_PHONETIC

public static final ClientProperty CLIENT_NICKNAME_PHONETIC

CLIENT_OUTPUT_HARDWARE

public static final ClientProperty CLIENT_OUTPUT_HARDWARE

CLIENT_OUTPUT_MUTED

public static final ClientProperty CLIENT_OUTPUT_MUTED

CLIENT_OUTPUTONLY_MUTED

public static final ClientProperty CLIENT_OUTPUTONLY_MUTED

CLIENT_PLATFORM

public static final ClientProperty CLIENT_PLATFORM

CLIENT_SERVERGROUPS

public static final ClientProperty CLIENT_SERVERGROUPS

CLIENT_TALK_POWER

public static final ClientProperty CLIENT_TALK_POWER

CLIENT_TALK_REQUEST

public static final ClientProperty CLIENT_TALK_REQUEST

CLIENT_TALK_REQUEST_MSG

public static final ClientProperty CLIENT_TALK_REQUEST_MSG

CLIENT_TOTAL_BYTES_DOWNLOADED

public static final ClientProperty CLIENT_TOTAL_BYTES_DOWNLOADED

CLIENT_TOTAL_BYTES_UPLOADED

public static final ClientProperty CLIENT_TOTAL_BYTES_UPLOADED

CLIENT_TOTALCONNECTIONS

public static final ClientProperty CLIENT_TOTALCONNECTIONS

CLIENT_TYPE

public static final ClientProperty CLIENT_TYPE

CLIENT_UNIQUE_IDENTIFIER

public static final ClientProperty CLIENT_UNIQUE_IDENTIFIER

CLIENT_UNREAD_MESSAGES

public static final ClientProperty CLIENT_UNREAD_MESSAGES

CLIENT_VERSION

public static final ClientProperty CLIENT_VERSION

CONNECTION_BANDWIDTH_RECEIVED_LAST_MINUTE_TOTAL

public static final ClientProperty CONNECTION_BANDWIDTH_RECEIVED_LAST_MINUTE_TOTAL

CONNECTION_BANDWIDTH_RECEIVED_LAST_SECOND_TOTAL

public static final ClientProperty CONNECTION_BANDWIDTH_RECEIVED_LAST_SECOND_TOTAL

CONNECTION_BANDWIDTH_SENT_LAST_MINUTE_TOTAL

public static final ClientProperty CONNECTION_BANDWIDTH_SENT_LAST_MINUTE_TOTAL

CONNECTION_BANDWIDTH_SENT_LAST_SECOND_TOTAL

public static final ClientProperty CONNECTION_BANDWIDTH_SENT_LAST_SECOND_TOTAL

CONNECTION_BYTES_RECEIVED_TOTAL

public static final ClientProperty CONNECTION_BYTES_RECEIVED_TOTAL

CONNECTION_BYTES_SENT_TOTAL

public static final ClientProperty CONNECTION_BYTES_SENT_TOTAL

CONNECTION_CLIENT_IP

public static final ClientProperty CONNECTION_CLIENT_IP

CONNECTION_CONNECTED_TIME

public static final ClientProperty CONNECTION_CONNECTED_TIME

CONNECTION_FILETRANSFER_BANDWIDTH_RECEIVED

public static final ClientProperty CONNECTION_FILETRANSFER_BANDWIDTH_RECEIVED

CONNECTION_FILETRANSFER_BANDWIDTH_SENT

public static final ClientProperty CONNECTION_FILETRANSFER_BANDWIDTH_SENT

CONNECTION_PACKETS_RECEIVED_TOTAL

public static final ClientProperty CONNECTION_PACKETS_RECEIVED_TOTAL

CONNECTION_PACKETS_SENT_TOTAL

public static final ClientProperty CONNECTION_PACKETS_SENT_TOTAL

Method Detail

values

public static ClientProperty[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (ClientProperty c : ClientProperty.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static ClientProperty valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

getName

public String getName()

Specified by:

getName in interface Property

isChangeable

public boolean isChangeable()

Specified by:

isChangeable in interface Property