001/** 002 * 003 * Copyright 2013-2014 Georg Lukas 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.receipts; 018 019import org.jivesoftware.smack.packet.Stanza; 020 021import org.jxmpp.jid.Jid; 022 023/** 024 * Interface for received receipt notifications. 025 * 026 * Implement this and add a listener to get notified. 027 */ 028public interface ReceiptReceivedListener { 029 /** 030 * Callback invoked when a new receipt got received. 031 * <p> 032 * {@code receiptId} correspondents to the message ID, which can be obtained with 033 * {@link org.jivesoftware.smack.packet.Stanza#getStanzaId()}. 034 * </p> 035 * 036 * @param fromJid the jid that send this receipt 037 * @param toJid the jid which received this receipt 038 * @param receiptId the message ID of the stanza which has been received and this receipt is for. 039 * This might be {@code null}. 040 * @param receipt the receipt 041 */ 042 void onReceiptReceived(Jid fromJid, Jid toJid, String receiptId, Stanza receipt); 043}