com.github.theholywaffle.teamspeak3.api

Enum PermissionGroupType

java.lang.Object

java.lang.Enum<PermissionGroupType>

com.github.theholywaffle.teamspeak3.api.PermissionGroupType

All Implemented Interfaces:

Serializable, Comparable<PermissionGroupType>

public enum PermissionGroupType
extends Enum<PermissionGroupType>

An enum describing where a PermissionAssignment originates from.

Enum Constant Summary

Enum Constants

Enum Constant and Description
CHANNEL A permission requirement for certain actions in a channel.
CHANNEL_CLIENT A permission assigned to a client in a specific channel.
CHANNEL_GROUP A permission assigned to a channel group.
GLOBAL_CLIENT A permission assigned to a client on a server-wide level.
SERVER_GROUP A permission assigned to a server group.

Method Summary

Methods

Modifier and Type	Method and Description
int	getIndex()
static PermissionGroupType	valueOf(String name) Returns the enum constant of this type with the specified name.
static PermissionGroupType[]	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

SERVER_GROUP

public static final PermissionGroupType SERVER_GROUP

A permission assigned to a server group.

GLOBAL_CLIENT

public static final PermissionGroupType GLOBAL_CLIENT

A permission assigned to a client on a server-wide level.

CHANNEL

public static final PermissionGroupType CHANNEL

A permission requirement for certain actions in a channel.

Examples: Join, talk, subscribe and file upload permission requirements

CHANNEL_GROUP

public static final PermissionGroupType CHANNEL_GROUP

A permission assigned to a channel group.

CHANNEL_CLIENT

public static final PermissionGroupType CHANNEL_CLIENT

A permission assigned to a client in a specific channel.

This is mostly used for the priority speaker feature by granting b_client_is_priority_speaker to a client in a channel.

Method Detail

values

public static PermissionGroupType[] 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 (PermissionGroupType c : PermissionGroupType.values())
    System.out.println(c);

Returns:

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

valueOf

public static PermissionGroupType 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

getIndex

public int getIndex()