001/**
002 *
003 * Copyright 2003-2007 Jive Software.
004 *
005 * Licensed under the Apache License, Version 2.0 (the "License");
006 * you may not use this file except in compliance with the License.
007 * You may obtain a copy of the License at
008 *
009 *     http://www.apache.org/licenses/LICENSE-2.0
010 *
011 * Unless required by applicable law or agreed to in writing, software
012 * distributed under the License is distributed on an "AS IS" BASIS,
013 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
014 * See the License for the specific language governing permissions and
015 * limitations under the License.
016 */
017
018package org.jivesoftware.smackx.chatstates;
019
020import org.jivesoftware.smack.chat.ChatMessageListener;
021import org.jivesoftware.smack.packet.Message;
022
023/**
024 * Events for when the state of a user in a chat changes.
025 *
026 * @author Alexander Wenckus
027 */
028public interface ChatStateListener extends ChatMessageListener {
029
030    /**
031     * Fired when the state of a chat with another user changes.
032     *
033     * @param chat the chat in which the state has changed.
034     * @param state the new state of the participant.
035     * @param message the message carrying the chat state.
036     */
037    // TODO Migrate to new chat2 API on Smack 4.3.
038    @SuppressWarnings("deprecation")
039    void stateChanged(org.jivesoftware.smack.chat.Chat chat, ChatState state, Message message);
040}