com.github.theholywaffle.teamspeak3.api.event.TextMessageEvent Maven / Gradle / Ivy

package com.github.theholywaffle.teamspeak3.api.event;

/*
 * #%L
 * TeamSpeak 3 Java API
 * %%
 * Copyright (C) 2014 Bert De Geyter
 * %%
 * 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.
 * #L%
 */

import com.github.theholywaffle.teamspeak3.api.TextMessageTargetMode;

import java.util.Map;

public class TextMessageEvent extends BaseEvent {

	public TextMessageEvent(Map map) {
		super(map);
	}

	public TextMessageTargetMode getTargetMode() {
		int mode = getInt("targetmode");
		for (TextMessageTargetMode m : TextMessageTargetMode.values()) {
			if (m.getIndex() == mode) {
				return m;
			}
		}
		return null;
	}

	public String getMessage() {
		return get("msg");
	}

	/**
	 * Gets the client ID of the recipient of a private message.
	 * 
	 * If the private message was sent to the query, the target ID will be the query's client ID
	 * If the private message was sent by the query, the target ID will be the recipient's client ID
	 * If this is not an event for a private message, this method will return {@code -1}
	 * 
	 *
	 * @return the client ID of the recipient
	 */
	public int getTargetClientId() {
		return getInt("target");
	}

	@Override
	public void fire(TS3Listener listener) {
		listener.onTextMessage(this);
	}
}