org.cubeengine.teamcom.query.command.SendTextmessage 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;
import org.cubeengine.teamcom.query.exception.TeamComException;
import org.cubeengine.teamcom.query.QueryConnection;
import org.cubeengine.teamcom.query.QueryConnection.QueryCurrent;
import org.cubeengine.teamcom.query.value.TargetMode;

/**
 * Sends a text message a specified target.
 * 
The type of the target is determined by targetmode while target specifies the ID of the recipient, whether it be a virtual server, a channel or a client.
 * 
For detailed information, see Definitions.
 * 


 * Syntax:
 * 
sendtextmessage targetmode={1-3} target={serverID|channelID|clientID} msg={text}
 */
public class SendTextmessage extends Command
{
    public SendTextmessage send(TargetMode mode, int target, String text)
    {
        this.setParam("targetmode", mode);
        this.setParam("target", target);
        this.setParam("msg", text);
        return this;
    }
    //Permissions:"i_client_private_textmessage_power i_client_needed_private_textmessage_power b_client_server_textmessage_send b_client_channel_textmessage_send"

    @Override
    protected String execute(QueryConnection query) throws TeamComException
    {
        String result = null;
        QueryCurrent current = query.getCurrent();
        switch ((TargetMode)this.arguments.get("targetmode"))
        {
        case CHANNEL:
            if (!current.isInChannel(arguments.get("target")))
            {
                current.moveToChannel((Integer)arguments.get("target"), query);
                result = super.execute(query);
                current.moveToChannel(null, query);
            }
            break;
        case VIRTUALSERVER:
            if (!current.isOnServer(arguments.get("target")))
            {
                current.chooseServer((Integer)arguments.get("target"), query);
                result = super.execute(query);
                current.chooseServer(null, query);
            }
        }
        if (result == null)
        {
            result = super.execute(query);
        }
        return result;
    }
}