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.api.wrapper.PermissionAssignment;
030
031/**
032 * An enum describing where a {@link PermissionAssignment} originates from.
033 */
034public enum PermissionGroupType {
035
036        /**
037         * A permission assigned to a server group.
038         */
039        SERVER_GROUP(0),
040
041        /**
042         * A permission assigned to a client on a server-wide level.
043         */
044        GLOBAL_CLIENT(1),
045
046        /**
047         * A permission requirement for certain actions in a channel.
048         * <p>
049         * Examples: Join, talk, subscribe and file upload permission requirements
050         * </p>
051         */
052        CHANNEL(2),
053
054        /**
055         * A permission assigned to a channel group.
056         */
057        CHANNEL_GROUP(3),
058
059        /**
060         * A permission assigned to a client in a specific channel.
061         * <p>
062         * This is mostly used for the priority speaker feature by granting
063         * {@code b_client_is_priority_speaker} to a client in a channel.
064         * </p>
065         */
066        CHANNEL_CLIENT(4);
067
068        private final int i;
069
070        PermissionGroupType(int i) {
071                this.i = i;
072        }
073
074        public int getIndex() {
075                return i;
076        }
077
078}