com.github.theholywaffle.teamspeak3.api.wrapper

Class PermissionAssignment

java.lang.Object

com.github.theholywaffle.teamspeak3.api.wrapper.Wrapper

com.github.theholywaffle.teamspeak3.api.wrapper.PermissionAssignment

public class PermissionAssignment
extends Wrapper

Describes a single permission that is assigned to a varying target.

This class is used when a lot of permissions are sent at once. To reduce bandwidth usage, the TS3 server only transmit the numeric permission ID and not the permission name.

For a complete description of the TS3 permission system, refer to this post on the TeamSpeak forums.

Field Summary

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

EMPTY

Constructor Summary

Constructors

Constructor and Description
PermissionAssignment(Map<String,String> map)

Method Summary

Modifier and Type	Method and Description
int	getId() Gets the numerical ID of this permission.
int	getMajorId() Specifies where this permission assignment originates from, depending on the type of this assignment.
int	getMinorId() Specifies where this permission assignment originates from, depending on the type of this assignment.
PermissionGroupType	getType() Where this permission assignment originates from.
int	getValue() Gets the value of this permission assignment.
boolean	isNegated() Returns true if this permission is negated.
boolean	isSkipped() Returns true if this permission is skipped.

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

PermissionAssignment

public PermissionAssignment(Map<String,String> map)

Method Detail

getType

public PermissionGroupType getType()

Where this permission assignment originates from.

Returns:

the type of this permission assignment

getMajorId

public int getMajorId()

Specifies where this permission assignment originates from, depending on the type of this assignment.

x -> y := In case type is x, majorId means y

SERVER_GROUP -> Server group ID
GLOBAL_CLIENT -> Client database ID
CHANNEL -> Channel ID
CHANNEL_GROUP -> Channel ID
CHANNEL_CLIENT -> Channel ID

Returns:

the major ID of the source of this assignment as described above

getMinorId

public int getMinorId()

Specifies where this permission assignment originates from, depending on the type of this assignment.

x -> y := In case type is x, minorId means y

CHANNEL_GROUP -> Channel group ID
CHANNEL_CLIENT -> Client database ID

Otherwise getMinorId() is undefined should return 0.

Returns:

the minor ID of the source of this assignment as described above

getId

public int getId()

Gets the numerical ID of this permission.

Returns:

this permission's numerical ID

getValue

public int getValue()

Gets the value of this permission assignment.

Please note that this value doesn't necessarily have to be the effective permission value for a client, as this assignment can be overridden by another assignment.

Integer permissions usually have values between 0 and 100, but any integer value is theoretically valid.

Boolean permissions have a value of 0 to represent false and 1 to represent true.

Returns:

the value of this permission assignment

isNegated

public boolean isNegated()

Returns true if this permission is negated.

Negated means that instead of the highest value, the lowest value will be selected for this permission instead.

Returns:

whether this permission is negated or not

isSkipped

public boolean isSkipped()

Returns true if this permission is skipped.

Skipped only exists for server group and client permissions, therefore this value will always be false for channel group permissions.

If a client permission is skipped, it won't be overridden by channel group permissions.
If a server group permission is skipped, it won't be overridden by channel group or client permissions.

Returns:

whether this permission is negated or not