001/**
002 *
003 * Copyright 2018 Miguel Hincapie.
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 */
017package org.jivesoftware.smackx.chat_markers;
018
019import org.jivesoftware.smack.chat2.Chat;
020import org.jivesoftware.smack.packet.Message;
021
022/**
023 * Chat Markers Manager class (XEP-0333).
024 *
025 * @author Miguel Hincapie
026 * @see <a href="http://xmpp.org/extensions/xep-0333.html">XEP-0333: Chat
027 * Markers</a>
028 */
029public interface ChatMarkersListener {
030    /**
031     * Called in ChatMarkersManager when a new message with a markable tag arrives.
032     *
033     * @param chatMarkersState the current state of the message.
034     * @param message          the new incoming message with a markable XML tag.
035     * @param chat             associated to the message. This element can be <code>NULL</code>.
036     */
037    void newChatMarkerMessage(ChatMarkersState chatMarkersState, Message message, Chat chat);
038}