001package com.github.theholywaffle.teamspeak3.api.event;
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.TextMessageTargetMode;
030import com.github.theholywaffle.teamspeak3.api.wrapper.Wrapper;
031
032public class TextMessageEvent extends BaseEvent {
033
034        public TextMessageEvent(Wrapper wrapper) {
035                super(wrapper);
036        }
037
038        public TextMessageTargetMode getTargetMode() {
039                int mode = getInt("targetmode");
040                for (TextMessageTargetMode m : TextMessageTargetMode.values()) {
041                        if (m.getIndex() == mode) {
042                                return m;
043                        }
044                }
045                return null;
046        }
047
048        public String getMessage() {
049                return get("msg");
050        }
051
052        /**
053         * Gets the client ID of the recipient of a private message.
054         * <ul>
055         * <li>If the private message was sent <b>to</b> the query, the target ID will be the query's client ID</li>
056         * <li>If the private message was sent <b>by</b> the query, the target ID will be the recipient's client ID</li>
057         * <li>If this is not an event for a private message, this method will return {@code -1}</li>
058         * </ul>
059         *
060         * @return the client ID of the recipient
061         */
062        public int getTargetClientId() {
063                return getInt("target");
064        }
065
066        @Override
067        public void fire(TS3Listener listener) {
068                listener.onTextMessage(this);
069        }
070}