org.cubeengine.teamcom.query.command.BanAdd 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 new ban rule on the selected virtual server.
 * 
All parameters are optional but at least one of the following must be set: ip, name, or uid.
 * 


 * Syntax:
 * 
banadd [ip={regexp}] [name={regexp}] [uid={clientUID}] [time={timeInSeconds}] [banreason={text}]
 */
public class BanAdd extends Command
{
    public BanAdd addByUId(String uid)
    {
        this.setParam("uid", uid);
        return this;
    }

    public BanAdd addByName(String regex)
    {
        this.setParam("name", regex);
        return this;
    }

    public BanAdd addByIp(String regex)
    {
        this.setParam("ip", regex);
        return this;
    }

    public BanAdd withReason(String reason)
    {
        this.setParam("banreason", reason);
        return this;
    }

    public BanAdd temporary(int seconds)
    {
        this.setParam("time", seconds);
        return this;
    }
    //Permissions:"b_client_ban_create"
}