Client (TeamSpeak 3 Java API 1.1.0 API)

java.lang.Object
- com.github.theholywaffle.teamspeak3.api.wrapper.Wrapper
- - com.github.theholywaffle.teamspeak3.api.wrapper.Client

Direct Known Subclasses:

ClientInfo
```
public class Client
extends Wrapper
```

Field Summary
- Fields inherited from class com.github.theholywaffle.teamspeak3.api.wrapper.Wrapper
  EMPTY

Constructor Summary

Constructors
Constructor and Description

Client(Map<String,String> map)

Constructors
Constructor and Description
`Client(Map<String,String> map)`

Method Summary

Methods
Modifier and Type	Method and Description
`boolean`	`canTalk()`
`String`	`getAwayMessage()`
`String[]`	`getBadgeGUIDs()`
`int`	`getChannelGroupId()`
`int`	`getChannelId()`
`String`	`getClientURI()` Utility method.
`String`	`getCountry()`
`Date`	`getCreatedDate()`
`int`	`getDatabaseId()`
`long`	`getIconId()`
`int`	`getId()`
`long`	`getIdleTime()`
`int`	`getInheritedChannelGroupId()`
`String`	`getIp()`
`Date`	`getLastConnectedDate()`
`String`	`getNickname()`
`String`	`getPlatform()`
`int[]`	`getServerGroups()`
`int`	`getTalkPower()`
`int`	`getType()`
`String`	`getUniqueIdentifier()`
`String`	`getVersion()`
`boolean`	`hasOverwolf()`
`boolean`	`isAway()`
`boolean`	`isChannelCommander()`
`boolean`	`isInputHardware()`
`boolean`	`isInputMuted()`
`boolean`	`isInServerGroup(int serverGroupId)` Utility method that does a linear search on the array of server group IDs returned by `getServerGroups()` and returns `true` if that array contains the given server group ID.
`boolean`	`isInServerGroup(ServerGroup serverGroup)` Utility method that does a linear search on the array of server group IDs returned by `getServerGroups()` and returns `true` if that array contains the ID of the given server group.
`boolean`	`isOutputHardware()`
`boolean`	`isOutputMuted()`
`boolean`	`isPrioritySpeaker()`
`boolean`	`isRecording()`
`boolean`	`isRegularClient()`
`boolean`	`isServerQueryClient()`
`boolean`	`isTalking()`

Methods inherited from class com.github.theholywaffle.teamspeak3.api.wrapper.Wrapper
get, get, getBoolean, getBoolean, getDouble, getDouble, getInt, getInt, getLong, getLong, getMap, toString

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - Client
```
public Client(Map<String,String> map)
```
- Method Detail
  - canTalk
```
public boolean canTalk()
```
  - getAwayMessage
```
public String getAwayMessage()
```
  - getBadgeGUIDs
```
public String[] getBadgeGUIDs()
```
  - getChannelGroupId
```
public int getChannelGroupId()
```
  - getChannelId
```
public int getChannelId()
```
  - getClientURI
```
public String getClientURI()
```
    Utility method. This method will return a client URI. A client URI can be used to reference a client in descriptions or just via chat. Example: client://<clientId>/<clientUId>~<clientNickname>
    
    Returns:
    Client's URI
  - getCountry
```
public String getCountry()
```
  - getCreatedDate
```
public Date getCreatedDate()
```
  - getDatabaseId
```
public int getDatabaseId()
```
  - getIconId
```
public long getIconId()
```
  - getId
```
public int getId()
```
  - getIdleTime
```
public long getIdleTime()
```
  - getInheritedChannelGroupId
```
public int getInheritedChannelGroupId()
```
  - getIp
```
public String getIp()
```
  - getLastConnectedDate
```
public Date getLastConnectedDate()
```
  - getNickname
```
public String getNickname()
```
  - getPlatform
```
public String getPlatform()
```
  - getServerGroups
```
public int[] getServerGroups()
```
  - getTalkPower
```
public int getTalkPower()
```
  - getType
```
public int getType()
```
  - getUniqueIdentifier
```
public String getUniqueIdentifier()
```
  - getVersion
```
public String getVersion()
```
  - hasOverwolf
```
public boolean hasOverwolf()
```
  - isAway
```
public boolean isAway()
```
  - isChannelCommander
```
public boolean isChannelCommander()
```
  - isInServerGroup
```
public boolean isInServerGroup(int serverGroupId)
```
    Utility method that does a linear search on the array of server group IDs returned by getServerGroups() and returns true if that array contains the given server group ID.
    
    Parameters:
    serverGroupId - the ID of the server group to search for
    
    Returns:
    whether this client is a member of the given server group
  - isInServerGroup
```
public boolean isInServerGroup(ServerGroup serverGroup)
```
    Utility method that does a linear search on the array of server group IDs returned by getServerGroups() and returns true if that array contains the ID of the given server group.
    
    Parameters:
    serverGroup - the server group to search for
    
    Returns:
    whether this client is a member of the given server group
  - isInputHardware
```
public boolean isInputHardware()
```
  - isInputMuted
```
public boolean isInputMuted()
```
  - isOutputHardware
```
public boolean isOutputHardware()
```
  - isOutputMuted
```
public boolean isOutputMuted()
```
  - isPrioritySpeaker
```
public boolean isPrioritySpeaker()
```
  - isRecording
```
public boolean isRecording()
```
  - isRegularClient
```
public boolean isRegularClient()
```
  - isServerQueryClient
```
public boolean isServerQueryClient()
```
  - isTalking
```
public boolean isTalking()
```

Class Client

Field Summary

Fields inherited from class com.github.theholywaffle.teamspeak3.api.wrapper.Wrapper

Constructor Summary

Method Summary

Methods inherited from class com.github.theholywaffle.teamspeak3.api.wrapper.Wrapper

Methods inherited from class java.lang.Object

Constructor Detail

Client

Method Detail

canTalk

getAwayMessage

getBadgeGUIDs

getChannelGroupId

getChannelId

getClientURI

getCountry

getCreatedDate

getDatabaseId

getIconId

getId

getIdleTime

getInheritedChannelGroupId

getIp

getLastConnectedDate

getNickname

getPlatform

getServerGroups

getTalkPower

getType

getUniqueIdentifier

getVersion

hasOverwolf

isAway

isChannelCommander

isInServerGroup

isInServerGroup

isInputHardware

isInputMuted

isOutputHardware

isOutputMuted

isPrioritySpeaker

isRecording

isRegularClient

isServerQueryClient

isTalking