mirror of
https://github.com/vanitasvitae/Smack.git
synced 2024-06-25 21:04:50 +02:00
bfefbdb777
This patch provides three components required to implement XEP-0184:
* DeliveryReceiptRequest is a PacketExtension to request a receipt
* DeliveryReceipt is a PacketExtension that contains the receipt
* DeliveryReceiptManager to handle sending/receiving of requests and
receipts.
Implementation:
For requesting a receipt, just add a new DeliveryReceiptRequest() to
your message or use the helper function:
DeliveryReceiptManager.addDeliveryReceiptRequest(packet);
Register a ReceiptReceivedListener to find out if your packet arrived:
DeliveryReceiptManager.getInstanceFor(myConnection)
.registerReceiptReceivedListener(new ReceiptReceivedListener() {
@Override public void onReceiptReceived(String fromJid,
String toJid, String receiptId) {
// receipt received for packet id receiptId
}
To answer a receipt request, you can either check incoming packets
manually:
if (DeliveryReceiptManager.hasDeliveryReceiptRequest(packet)) {
// send receipt
}
Or you can enable automatic receipt transmission with:
DeliveryReceiptManager.getInstanceFor(myConnection)
.setAutoReceiptsEnabled(true);
Signed-Off-By: Georg Lukas <georg@op-co.de>
git-svn-id: http://svn.igniterealtime.org/svn/repos/smack/trunk@13431 b35dd754-fafc-0310-a699-88a17e54d16e
75 lines
2.1 KiB
Java
75 lines
2.1 KiB
Java
/*
|
|
* All rights reserved. Licensed under the Apache License, Version 2.0 (the "License");
|
|
* you may not use this file except in compliance with the License.
|
|
* You may obtain a copy of the License at
|
|
*
|
|
* http://www.apache.org/licenses/LICENSE-2.0
|
|
*
|
|
* Unless required by applicable law or agreed to in writing, software
|
|
* distributed under the License is distributed on an "AS IS" BASIS,
|
|
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
* See the License for the specific language governing permissions and
|
|
* limitations under the License.
|
|
*/
|
|
package org.jivesoftware.smackx.receipts;
|
|
|
|
import java.util.List;
|
|
import java.util.Map;
|
|
|
|
import org.jivesoftware.smack.packet.PacketExtension;
|
|
import org.jivesoftware.smack.provider.EmbeddedExtensionProvider;
|
|
|
|
/**
|
|
* Represents a <b>message delivery receipt</b> entry as specified by
|
|
* <a href="http://xmpp.org/extensions/xep-0184.html">Message Delivery Receipts</a>.
|
|
*
|
|
* @author Georg Lukas
|
|
*/
|
|
public class DeliveryReceipt implements PacketExtension
|
|
{
|
|
public static final String NAMESPACE = "urn:xmpp:receipts";
|
|
public static final String ELEMENT = "received";
|
|
|
|
private String id; /// original ID of the delivered message
|
|
|
|
public DeliveryReceipt(String id)
|
|
{
|
|
this.id = id;
|
|
}
|
|
|
|
public String getId()
|
|
{
|
|
return id;
|
|
}
|
|
|
|
public String getElementName()
|
|
{
|
|
return ELEMENT;
|
|
}
|
|
|
|
public String getNamespace()
|
|
{
|
|
return NAMESPACE;
|
|
}
|
|
|
|
public String toXML()
|
|
{
|
|
return "<received xmlns='" + NAMESPACE + "' id='" + id + "'/>";
|
|
}
|
|
|
|
/**
|
|
* This Provider parses and returns DeliveryReceipt packets.
|
|
*/
|
|
public static class Provider extends EmbeddedExtensionProvider
|
|
{
|
|
|
|
@Override
|
|
protected PacketExtension createReturnExtension(String currentElement, String currentNamespace,
|
|
Map<String, String> attributeMap, List<? extends PacketExtension> content)
|
|
{
|
|
return new DeliveryReceipt(attributeMap.get("id"));
|
|
}
|
|
|
|
}
|
|
}
|