org.cubeengine.teamcom.query.command.ServerGroupAutoAddPerm Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of teamcom Show documentation
A Teamspeak 3 API
The newest version!
/*
 * The MIT License
 * Copyright © 2013 Cube Island
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 */
package org.cubeengine.teamcom.query.command;

import org.cubeengine.teamcom.query.Command;

/**
 * Adds a set of specified permissions to *ALL* regular server groups on all virtual servers.
 * 
The target groups will be identified by the value of their i_group_auto_update_type permission specified with sgtype.
 * 
Multiple permissions can be added at once. A permission can be specified by permid or permsid.
 * 
The known values for sgtype are:
 * 
10: Channel Guest
 * 
15: Server Guest
 * 
20: Query Guest
 * 
25: Channel Voice
 * 
30: Server Normal
 * 
35: Channel Operator
 * 
40: Channel Admin
 * 
45: Server Admin
 * 
50: Query Admin
 * 


 * Syntax:
 * 
servergroupautoaddperm sgtype={groupID} [permid={permID}…] [permsid={permName}…] permvalue={permValue}… permnegated={1|0}… permskip={1|0}…
 */
public class ServerGroupAutoAddPerm extends Command
{
    public ServerGroupAutoAddPerm addById(int serverGroupType, int permissionId, int value, boolean negate,
                                          boolean skip)
    {
        this.setParam("sgtype", serverGroupType);
        this.setParam("permid", permissionId);
        this.setParam("permvalue", value);
        this.setParam("permnegated", negate);
        this.setParam("permskip", skip);
        return this;
    }

    public ServerGroupAutoAddPerm addByName(int serverGroupType, String permissionName, int value, boolean negate,
                                            boolean skip)
    {
        this.setParam("sgtype", serverGroupType);
        this.setParam("permsid", permissionName);
        this.setParam("permvalue", value);
        this.setParam("permnegated", negate);
        this.setParam("permskip", skip);
        return this;
    }
    //Permissions:"b_permission_modify_power_ignore"
}